Re: What are the xxx_docs_override.xml files good for?



2014-04-15 10:54 GMT+02:00 Kjell Ahlstedt <kjell ahlstedt bredband net>:
I just noticed that the documention of Gtk::Dialog::run() is fetched from gtkmm/gtk/src/gtk_docs_override.xml instead of gtk_docs.xml. Updates to the documentation of gtk_dialog_run() from the last 11 years are not copied to Gtk::Dialog::run().

I suppose that an entry for gtk_dialog_run() was added to gtk_docs_override.xml because a C++ code snippet could be added to the documentation. That doesn't work well nowadays. Gmmproc removes all code snippets.

When we don't want to use the documentation  of a gtk+ function in gtkmm, IMO it's better to write the gtkmm documentation in the .hg file instead of writing it in the gtk_docs_override.xml, where almost no one looks.

If I remember correctly, overriding documentation by adding entry to xxx_docs_override.xml was the only way to do it, before gmmproc learned to handle docs in hg files. So, I'd say that this would be deprecated by now.
 

Kjell

_______________________________________________
gtkmm-list mailing list
gtkmm-list gnome org
https://mail.gnome.org/mailman/listinfo/gtkmm-list




[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]