"Fossies" - the Fresh Open Source Software Archive

Member "glibmm-2.76.0/docs/internal/documentation_generation.txt" (12 Mar 2023, 1251 Bytes) of package /linux/misc/glibmm-2.76.0.tar.xz:

    1 *** Reference documentation.
    2 - Type "make" in docs/reference to generate HTML docs
    3   from the source code.
    4 - We use Doxygen.
    5   Doxygen comments: Use either
    6 
    7   /// This does something.
    8   void something()
    9 
   10   or
   11 
   12   /** This does something
   13    * It does it like so.
   14    * @param foo The foo to be somethinged.
   15    */
   16   void something(Foo& foo);
   17 
   18   Rememeber to actually look at the documentation before adding these
   19   comments to the .hg files. It might not be necessary because
   20   gtkmmproc might do it for you - see the next section.
   21   
   22 - Reuse of GTK+ documentation:
   23     When gtkmmproc generates the .h/.cc files from the .hg/.ccg files,
   24   it inserts doxygen comments based on the gtk-doc comments in the
   25   GTK+ source code.
   26     gtkmmproc does this by looking at gtk/src/gtk_docs.xml, which is
   27   generated occasionally by the pygtk/codegen/docextract_to_xml.py
   28   python script, in the gnome-python cvs module.
   29 
   30 - Overriding the GTK documentation:
   31     Sometimes the GTK documentation for a functoin is not appropriate
   32     for the gtkmm method that wraps it. If so, you should add a
   33     section to gtk/src/gtk_docs_override.xml
   34 
   35 
   36 *** Book
   37 - The "Programming with gtkmmproc" book is in DocBook XML 4 format.
   38 - Type make in docs/tutorial to build the HTML.
   39 
   40 
   41