[gtk-doc] TODO: more planning
- From: Stefan Kost <stefkost src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-doc] TODO: more planning
- Date: Sun, 9 Feb 2014 12:07:09 +0000 (UTC)
commit e959bdbd12eb245c6a5422f2decae49501834db2
Author: Stefan Sauer <ensonic users sf net>
Date: Sun Feb 9 13:01:12 2014 +0100
TODO: more planning
TODO | 29 ++++++++++++++++++++++++-----
1 files changed, 24 insertions(+), 5 deletions(-)
---
diff --git a/TODO b/TODO
index 51c0d28..66e5474 100644
--- a/TODO
+++ b/TODO
@@ -16,11 +16,30 @@ and join discussion about future features.
Developers can also add items here :)
-= Cleanups =
-== get rid of the -section.txt file ==
-* section-title can be in SECTION comment already
-* when scanning a header file, everything will be put to one section
- * like we do for autogenerated section.txt file (gtkdoc-scan)
+= Less files to manually edit =
+The goal is that we configure gtk-doc in configure.ac and Makefile.am and
+document the code in the sources. Right no we also have to edit a bunch of extra
+files:
+ * $(DOC_MODULE).types
+ * $(DOC_MODULE)-docs.xml
+ * $(DOC_MODULE)-sections.txt
+
+== .types ==
+
+* using SCAN_OPTION="--rebuild-types" can be used to avoid maintaining the types
+ file
+* we need to check if this works well for all kind of _types (e.g. boxed)
+ https://bugzilla.gnome.org/show_bug.cgi?id=605025
+
+== -section.txt ==
+https://bugzilla.gnome.org/show_bug.cgi?id=646094
+
+* using SCAN_OPTION="--rebuild-sections" can be used to use the audogenerated
+ sections file
+* when scanning a header file, everything of the header and the respective .c
+ file will be put to one section
+* symbols can be hidden using __GTK_DOC_IGNORE__
+
* we need comment markup to override the section
e.g.: " * InSection: xxxx"
this needs gtkdoc-mkdb::ScanSourceFile to understand a new tag, which
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]