You've already forked gnatstudio
mirror of
https://github.com/AdaCore/gnatstudio.git
synced 2026-02-12 12:42:33 -08:00
25 lines
678 B
ReStructuredText
25 lines
678 B
ReStructuredText
***********************
|
|
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 GNAT Studio user's guide on how to make new documentation available to
|
|
users.
|
|
|
|
|