Changes between Version 12 and Version 13 of GtkDocPlugin


Ignore:
Timestamp:
Mar 26, 2016, 10:40:06 AM (8 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • GtkDocPlugin

    v12 v13  
    55== Description
    66
    7 This plugin integrates gtkdoc books into Trac's interface. This is accomplished by displaying the actual html output of gtkdoc, as well as integrating into the search engine in Trac.
     7This plugin integrates gtkdoc books into Trac's interface. This is accomplished by displaying the actual html output of gtkdoc, as well as integrating into the search engine in Trac. [http://www.gtk.org/gtk-doc/index.php GTK-Doc] generates API documentation from comments added to C code, but can also be used to document other application code such as Python.
    88
    9 There are three new user permissions in this plugin: `GTKDOC_SEARCH`, `GTKDOC_VIEW` and `GTKDOC_ADMIN`. `GTKDOC_VIEW` and `GTKDOC_SEARCH` is obviously to view and respectively to search in the API, where `GTKDOC_ADMIN` allows the addition and removal of books.
     9There are the following new user permissions in this plugin:
     10 * `GTKDOC_SEARCH`: search in the API documentation
     11 * `GTKDOC_VIEW`: view the API documentation
     12 * `GTKDOC_ADMIN`: allows the addition and removal of API documentation books
    1013
    1114As mentioned above the admin_interface provides an interface for adding and removing books. Books are keyed on a name given to them at the time they are added, as well as an absolute path on the local filesystem of where the book actually is. This way, you can update the documentation (with rsync for example) and not have to touch a thing in Trac.
     
    3740== Example
    3841
    39 See [http://www.gnugts.org/ gnugts.org]
     42See [http://www.gnugts.org/ gnugts.org].
    4043
    4144== Recent Changes