diff options
| author | Stefan Kost <stefkost@src.gnome.org> | 2005-09-19 21:06:19 +0000 |
|---|---|---|
| committer | Stefan Kost <stefkost@src.gnome.org> | 2005-09-19 21:06:19 +0000 |
| commit | 487222c34323610fb00f0d8087e6ce68f9778b84 (patch) | |
| tree | d412a869844ce9baf3c7795ab43dad2d146a64e1 /doc | |
| parent | 7d93794cc0049590b58589113ba0d25ec69bb0c0 (diff) | |
| download | gtk-doc-487222c34323610fb00f0d8087e6ce68f9778b84.tar.gz | |
adding a note about where the new docs are
* doc/README:
* doc/authors.txt:
* doc/gnome.txt:
* doc/sections-file.txt:
* doc/setting-up.txt:
* doc/style-guide.txt:
* gtkdoc-common.pl.in:
adding a note about where the new docs are
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README | 11 | ||||
| -rw-r--r-- | doc/authors.txt | 6 | ||||
| -rw-r--r-- | doc/gnome.txt | 9 | ||||
| -rw-r--r-- | doc/sections-file.txt | 9 | ||||
| -rw-r--r-- | doc/setting-up.txt | 6 | ||||
| -rw-r--r-- | doc/style-guide.txt | 6 |
6 files changed, 43 insertions, 4 deletions
@@ -1,5 +1,11 @@ +Note +==== -FILES +There is now a user manual which can be read using yelp and can be found under +'development'. Please refer to this documentation for up-to-date information. + + +Files ===== setting-up.txt @@ -13,12 +19,9 @@ sections-file.txt describes the MODULE-sections.txt file which is used to organise the documentation. - - style-guide.txt Initial draft of a style guide for writing GTK+ docs. authors.txt notes for authors of the GTK documentation. The abbreviations to use, a few useful DocBook tags etc. - diff --git a/doc/authors.txt b/doc/authors.txt index 2a84af3..b46b41c 100644 --- a/doc/authors.txt +++ b/doc/authors.txt @@ -1,3 +1,9 @@ +Note +==== + +There is now a user manual which can be read using yelp and can be found under +'development'. Please refer to this documentation for up-to-date information. + General ======= diff --git a/doc/gnome.txt b/doc/gnome.txt index 9b14bff..8ebffa1 100644 --- a/doc/gnome.txt +++ b/doc/gnome.txt @@ -1,3 +1,12 @@ +Note +==== + +There is now a user manual which can be read using yelp and can be found under +'development'. Please refer to this documentation for up-to-date information. + + +HowTo +===== These are the comment blocks used in Gnome source files to document functions (and macros, signals and properties, if you want). diff --git a/doc/sections-file.txt b/doc/sections-file.txt index 3ca7099..235d6e8 100644 --- a/doc/sections-file.txt +++ b/doc/sections-file.txt @@ -1,3 +1,12 @@ +Note +==== + +There is now a user manual which can be read using yelp and can be found under +'development'. Please refer to this documentation for up-to-date information. + + +*-section.txt +============= This describes the MODULE-sections.txt file which is used to organise the documentation output by gtk-doc. diff --git a/doc/setting-up.txt b/doc/setting-up.txt index 73f18d0..d3a6e5b 100644 --- a/doc/setting-up.txt +++ b/doc/setting-up.txt @@ -1,3 +1,9 @@ +Note +==== + +There is now a user manual which can be read using yelp and can be found under +'development'. Please refer to this documentation for up-to-date information. + How to Set Up an Application or Library to use GTK-Doc ====================================================== diff --git a/doc/style-guide.txt b/doc/style-guide.txt index 98d7256..59da5e4 100644 --- a/doc/style-guide.txt +++ b/doc/style-guide.txt @@ -1,3 +1,9 @@ +Note +==== + +There is now a user manual which can be read using yelp and can be found under +'development'. Please refer to this documentation for up-to-date information. + NOTE: This is only a draft version. Don't make major changes to your documentation until we've agreed on all this. |