diff options
| author | Sebastian Geiger <sbastig@gmx.net> | 2018-07-03 21:12:58 +0200 |
|---|---|---|
| committer | Sebastian Geiger <sbastig@gmx.net> | 2018-07-04 13:07:30 +0200 |
| commit | d0ae56a96c2adb841643128f90c89eeaaa74651c (patch) | |
| tree | f12072899d7e85eca7a79b140cd40a184b3af75f /help | |
| parent | a3e37a3e0bfb7f860edc8c29ed1c0b2a4ee378cc (diff) | |
| download | gtk-doc-d0ae56a96c2adb841643128f90c89eeaaa74651c.tar.gz | |
help/manual: add paragraph about history
Diffstat (limited to 'help')
| -rw-r--r-- | help/manual/C/index.docbook | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/help/manual/C/index.docbook b/help/manual/C/index.docbook index 9cd2d80..bc23fad 100644 --- a/help/manual/C/index.docbook +++ b/help/manual/C/index.docbook @@ -254,8 +254,7 @@ <guilabel>Writing the documentation.</guilabel> The author fills in the source files with the documentation for each - function, macro, union etc. (In the past information was entered in - generated template files, which is not recommended anymore). + function, macro, structs or unions, etc. </para> </listitem> @@ -357,11 +356,21 @@ <title>About GTK-Doc</title> <para> + Historically GTK-Doc was used to generate template files from the soures + code. These template files could be used by developers to enter the + API documentation. This approach was rather inconvenient because it + required to keep the generated files under version control. + Since GTK-Doc 1.9 it became possible to place all API information + into source comments, which made the template support obsolete. + In version 1.26 template support has been. + </para> + + <para> (FIXME) </para> <para> - (History, authors, web pages, mailing list, license, future plans, + (authors, web pages, mailing list, license, future plans, comparison with other similar systems.) </para> |