1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
***********************
Documenting your module
***********************
All modules should be documented, so that the users are aware of all
its capabilities.
There are several levels of documentation:
* Tooltips
It is recommended that all new preferences and as much of the GUI as
possible be documented through tooltips. This is the only help that
most users will read.
Tooltips are easily added directly with gtk+: Just call
`Gtk.Widget.Set_Tooltip_Text` or `Gtk.Widget.Set_Tooltip_Markup`
* extended documentation
Extended documentation should be written in HTML.
See the GPS user's guide on how to make new documentation available to
users.
|
