Add a long annotated parameter description (regression test for #613611)
[gtk-doc.git] / doc / README
blobf0636d637814b9cb52d4f1ef61a827603671cbce
1 Note
2 ====
4 There is now a user manual which can be read using yelp and can be found under
5 'development'. Please refer to this documentation for up-to-date information.
8 Files
9 =====
11 setting-up.txt
12     5-step guide to setting up a module to use gtk-doc.
14 gnome.txt
15     information on the source code comments format which the Gnome project
16     has just started to use.
18 sections-file.txt
19     describes the MODULE-sections.txt file which is used to organise the
20     documentation.
22 style-guide.txt
23     Initial draft of a style guide for writing GTK+ docs.
25 authors.txt
26     notes for authors of the GTK documentation. The abbreviations to use,
27     a few useful DocBook tags etc.