[gtk-doc] README: don't mention template files anymore
- From: Stefan Sauer <stefkost src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-doc] README: don't mention template files anymore
- Date: Sat, 13 May 2017 15:55:40 +0000 (UTC)
commit 4a6e489fe6f2410b319e5e8a28743d5b26e228ca
Author: Stefan Sauer <ensonic users sf net>
Date: Sat May 13 17:55:08 2017 +0200
README: don't mention template files anymore
README | 10 ++--------
1 files changed, 2 insertions(+), 8 deletions(-)
---
diff --git a/README b/README
index b052456..4b20e7c 100644
--- a/README
+++ b/README
@@ -13,14 +13,8 @@ at Doxygen (http://www.doxygen.org/). However GTK-Doc has some special code
to document the signals and properties of GTK+ widgets and GObject classes
which other tools may not have.
-GTK-Doc allows your documentation to be written in 2 ways:
- a) Embedded inside the source code in specially-formatted comments.
- or
- b) Added to the 'template' files which gtk-doc outputs after scanning all
- the header files and parsing the declarations (deprecated now).
-
-From these source code comments and template files GTK-Doc generates a Docbook
-XML document, which is then transformed into HTML and/or PDF.
+From your source code comments GTK-Doc generates a Docbook XML document, which
+is then transformed into HTML and/or PDF.
The generated HTML documentation can be browsed in an ordinary web browser or
by using the special Devhelp API browser
(see http://developer.imendio.com/wiki/Devhelp).
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]