|
Packit |
116408 |
Devhelp
|
|
Packit |
116408 |
=======
|
|
Packit |
116408 |
|
|
Packit |
116408 |
The Devhelp web page:
|
|
Packit |
116408 |
|
|
Packit |
116408 |
https://wiki.gnome.org/Apps/Devhelp
|
|
Packit |
116408 |
|
|
Packit |
116408 |
Dependencies
|
|
Packit |
116408 |
------------
|
|
Packit |
116408 |
|
|
Packit |
116408 |
- glib >= 2.40
|
|
Packit |
116408 |
- gtk+ >= 3.22
|
|
Packit |
116408 |
- webkit2gtk-4.0 >= 2.19.2
|
|
Packit |
116408 |
- gsettings-desktop-schemas
|
|
Packit |
116408 |
|
|
Packit |
116408 |
Description
|
|
Packit |
116408 |
-----------
|
|
Packit |
116408 |
|
|
Packit |
116408 |
Devhelp is a developer tool for browsing and searching API documentation.
|
|
Packit |
116408 |
It provides an easy way to navigate through libraries and to search by
|
|
Packit |
116408 |
function, struct, or macro.
|
|
Packit |
116408 |
|
|
Packit |
116408 |
The documentation must be installed locally, so an internet connection is
|
|
Packit |
116408 |
not needed to use Devhelp.
|
|
Packit |
116408 |
|
|
Packit |
116408 |
Devhelp works natively with GTK-Doc, so the GTK+ and GNOME libraries are
|
|
Packit |
116408 |
well supported. But other development platforms can be supported as well,
|
|
Packit |
116408 |
as long as the API documentation is available in HTML and a *.devhelp2
|
|
Packit |
116408 |
index file is generated.
|
|
Packit |
116408 |
|
|
Packit |
116408 |
Devhelp integrates with other applications such as Glade, Builder or
|
|
Packit |
116408 |
Anjuta, and plugins are available for different text editors (gedit, Vim,
|
|
Packit |
116408 |
Emacs, Geany, …).
|
|
Packit |
116408 |
|
|
Packit |
116408 |
Integration with other developer tools
|
|
Packit |
116408 |
--------------------------------------
|
|
Packit |
116408 |
|
|
Packit |
116408 |
Devhelp provides some command line options, such as --search and
|
|
Packit |
116408 |
--search-assistant. A text editor plugin can for example launch the command
|
|
Packit |
116408 |
`devhelp --search function_name` when a keyboard shortcut is pressed, with the
|
|
Packit |
116408 |
function_name under the cursor.
|
|
Packit |
116408 |
|
|
Packit |
116408 |
Devhelp also provides a shared library, to integrate the GTK+ widgets inside an
|
|
Packit |
116408 |
IDE. It is used for example by Builder and Anjuta.
|
|
Packit |
116408 |
|
|
Packit |
116408 |
For the --search command line option, see the class description of
|
|
Packit |
116408 |
DhKeywordModel, the search string supports additional features useful for IDEs
|
|
Packit |
116408 |
or other developer tools.
|
|
Packit |
116408 |
|
|
Packit |
116408 |
How it finds the API documentation
|
|
Packit |
116408 |
----------------------------------
|
|
Packit |
116408 |
|
|
Packit |
116408 |
When you build (or install) a GNOME library, GTK-Doc will build an API
|
|
Packit |
116408 |
reference for you and install it into:
|
|
Packit |
116408 |
|
|
Packit |
116408 |
$datadir/gtk-doc/html/$PACKAGE/
|
|
Packit |
116408 |
|
|
Packit |
116408 |
Along with the HTML files, a *.devhelp and/or *.devhelp2 index file is
|
|
Packit |
116408 |
also generated automatically. Thus Devhelp can simply scan that folder
|
|
Packit |
116408 |
for those index files and display the books they represent.
|
|
Packit |
116408 |
|
|
Packit |
116408 |
Devhelp uses the "XDG Base Directory Specification" to find
|
|
Packit |
116408 |
documentation. You can read more about that specification here:
|
|
Packit |
116408 |
|
|
Packit |
116408 |
https://specifications.freedesktop.org/basedir-spec/latest/
|
|
Packit |
116408 |
|
|
Packit |
116408 |
The list of locations searched for devhelp books is:
|
|
Packit |
116408 |
|
|
Packit |
116408 |
$XDG_DATA_HOME/devhelp/books
|
|
Packit |
116408 |
e.g. /home/ross/.local/share/devhelp/books/glib-2.0/glib-2.0.devhelp2
|
|
Packit |
116408 |
|
|
Packit |
116408 |
$XDG_DATA_HOME/gtk-doc/html
|
|
Packit |
116408 |
e.g. /home/ross/.local/share/gtk-doc/html/glib-2.0/glib-2.0.devhelp2
|
|
Packit |
116408 |
|
|
Packit |
116408 |
$XDG_DATA_DIRS/devhelp/books
|
|
Packit |
116408 |
e.g. /usr/local/share/devhelp/books/glib-2.0/glib-2.0.devhelp2
|
|
Packit |
116408 |
|
|
Packit |
116408 |
$XDG_DATA_DIRS/gtk-doc/html
|
|
Packit |
116408 |
e.g. /usr/local/share/gtk-doc/html/glib-2.0/glib-2.0.devhelp2
|
|
Packit |
116408 |
|
|
Packit |
116408 |
Note that the two latter consist of :-separated lists of directories to
|
|
Packit |
116408 |
look for. Those environment variables are normally set up by the
|
|
Packit |
116408 |
desktop environment or distribution.
|
|
Packit |
116408 |
|
|
Packit |
116408 |
Note that the name of the directory the *.devhelp2 file is in and the
|
|
Packit |
116408 |
name of the *.devhelp2 file (minus the extension) must match.
|
|
Packit |
116408 |
|
|
Packit |
116408 |
The first version of the index file format (with the *.devhelp file
|
|
Packit |
116408 |
extension) is deprecated and its support will probably be removed in a
|
|
Packit |
116408 |
future version. You should use the second version, with the *.devhelp2
|
|
Packit |
116408 |
file extension.
|