summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Fix typosRafael Fontenelle2018-10-032-4/+4
|
* db2html: split chunking and conversionStefan Sauer2017-12-151-0/+2
| | | | | | We need to do this to be able to create navigation. Use anytree for the tree of files. Add a very simple first jinja2 template and hook up a variable to an xpath expression.
* tools: add the start of an experiemnt to replace the xsl conversionStefan Sauer2017-12-101-4/+31
| | | | | | The new tool will chunk to a 'db2html' dir. It does not yet convert anything, but should create the same files as one would have in the 'html' dir.
* db2md: add check for future markdownStefan Sauer2017-11-151-2/+13
| | | | | We don't support emphasis yet, but will have to if we go this way. Check how much it would be randomly applied.
* db2md: start a new tool to migate docbook to mdStefan Sauer2017-11-121-5/+9
| | | | | Update the design plans and start a new tool. It only reports the docbook tags so far.
* design: more planning updatesStefan Sauer2017-11-081-1/+16
| | | | Add some commandline experiements.
* design: more planning updates for no-docbook futureStefan Sauer2017-11-081-15/+23
|
* design: add more details for the xml transitionStefan Sauer2017-11-011-0/+10
|
* design: design updateStefan Sauer2017-03-311-8/+40
| | | | Move db -> markdow to desgn doc and add a section about messages and report files.
* docs: update sgml todosStefan Sauer2017-03-221-2/+1
|
* sgml: remove docbook sgml toolsStefan Sauer2017-03-211-7/+0
| | | | | | We remove jade support already a few versions ago. Also remove the tools we've called from the pdf/man generators. For most of them configure was never checking the pre-requisites.
* mktmpl: remove the support for tmpl filesStefan Sauer2017-03-211-5/+4
| | | | We deprecated this many years ago. Now finally remove it.
* docs: spelling and maintenanceStefan Sauer2014-03-061-4/+4
|
* design: add links to wikicreole for new syntax ideasStefan Kost2010-10-181-0/+7
|
* todo: move one item to 2.x todo listStefan Kost2010-01-031-0/+3
|
* design: plans for less report filesStefan Kost2009-12-311-0/+7
|
* design: make -sections.txt file unneededStefan Kost2009-12-261-1/+2
|
* design: updateStefan Kost2009-12-252-0/+34
|
* docs: more xml-id researchStefan Kost2009-12-221-1/+13
|
* docs: design docs and commentsStefan Kost2009-12-222-0/+37
| | | | | Start to figure some design decission before my time and track ideas what should be changed in the future design. Update some comemnts accordingly.
* Improve. scan only checks headers, while mkdb scans sources and headers.Stefan Kost2009-02-261-4/+6
| | | | | | | | | | | * doc/gtkdoc.dot: Improve. scan only checks headers, while mkdb scans sources and headers. * examples/Makefile.am: Document more variables. svn path=/trunk/; revision=694
* planning. Document workflow Add support for enums/flags in devhelp index.Stefan Kost2008-10-131-0/+78
| | | | | | | | | | | | | | | | | | | | * TODO: planning. * doc/gtkdoc.dot: Document workflow * devhelp2.xsl: Add support for enums/flags in devhelp index. * gtkdoc-mkdb.in: Support annotations. Fix missing roles. * tests/annotations/docs/tester-docs.xml: * tests/annotations/src/tester.c: * tests/annotations/src/tester.h: * tests/bugs/docs/tester-sections.txt: * tests/gobject/docs/tester-docs.xml: Update new syntax. svn path=/trunk/; revision=607
* adding a note about where the new docs areStefan Kost2005-09-196-4/+43
| | | | | | | | | | | * 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
* allow the author to use <!--PARAMETERS--> to specify the position of theDamon Chaplin2004-10-141-0/+6
| | | | | | | | | | | | 2004-10-14 Damon Chaplin <damon@gnome.org> * gtkdoc-mkdb.in (OutputMacro, OutputFunction, GetSignals): allow the author to use <!--PARAMETERS--> to specify the position of the parameter table if they want. Hopefully good enough for bug #99567. (MergeSourceDocumentation): end the paragraph before <!--PARAMETERS--> and start a new one after it. * doc/authors.txt: document <!--PARAMETERS-->.
* create an empty MODULE-overrides.txt file if it doesn't exist. gtkdoc.makeDamon Chaplin2004-09-101-11/+37
| | | | | | | | | | | | | | | | | | | 2004-09-10 Damon Chaplin <damon@gnome.org> * gtkdoc-scan.in: create an empty MODULE-overrides.txt file if it doesn't exist. gtkdoc.make expects one to exist. * doc/setting-up.txt: updated to document new procedure using gtkdoc.make. * examples/Makefile.am: updated to use gtkdoc.make. * examples/configure.in: removed this. gtkdoc.make is used instead now. * examples/README: updated. * Makefile.am (EXTRA_DIST): removed examples/configure.in.
* mention use of '#' for comments.Damon Chaplin2004-07-281-0/+3
| | | | | | | | 2004-07-28 Damon Chaplin <damon@gnome.org> * doc/sections-file.txt: mention use of '#' for comments. * gtkdoc-mkdb.in: removed HEADER_FILE stuff, since it isn't used now.
* Prune private and foreign types as far as possible.Matthias Clasen2004-04-211-1/+3
|
* Some additions.Matthias Clasen2003-08-021-0/+14
|
* One more update.Matthias Clasen2003-06-111-1/+3
|
* Some documentation updates.Matthias Clasen2003-06-111-46/+59
|
* Typo fix.Matthias Clasen2003-04-201-1/+1
|
* added MAINTAINERS.Damon Chaplin2002-11-161-1/+1
| | | | | | | | | | | | | 2002-11-16 Damon Chaplin <damon@gnome.org> * Makefile.am (EXTRA_DIST): added MAINTAINERS. * README: updated requirements info, mainly to add XML stuff. * NEWS: added news for 0.10 * MAINTAINERS: * AUTHORS: updated my email address.
* replaced use of wildcard (which isn't portable) with original *.sgml. IDamon Chaplin2001-05-211-1/+2
| | | | | | | | | | | 2001-05-20 Damon Chaplin <damon@ximian.com> * examples/Makefile.am (sgml-build.stamp): replaced use of wildcard (which isn't portable) with original *.sgml. I think this just means that the first time you try to build the docs it will fail, but if you run make again it will work. * doc/setting-up.txt: explained that make may fail the first time.
* updated docs to cover simpler setup procedure.Damon Chaplin2001-05-208-871/+35
| | | | | | | | | | | | | | | | | | 2001-05-19 Damon Chaplin <damon@ximian.com> * README: * doc/README: * doc/setting-up.txt: * doc/sections-file.txt: * doc/authors.txt: updated docs to cover simpler setup procedure. * doc/gtk_button.txt: * doc/manpage: * doc/manpage.man: * doc/notes.txt: removed out-of date stuff. * Makefile.am (dist-hook): updated so it doesn't try to remove old examples subdirectory stuff.
* Released 0.4Damon Chaplin2000-10-211-1/+1
| | | | | | | | | | | | | | | 2000-10-21 Damon Chaplin <damon@helixcode.com> * Released 0.4 2000-10-14 Damon Chaplin <damon@helixcode.com> * AUTHORS: * MAINTAINERS: changed my email address. * Makefile.am (dist-hook): remove the CVS dirs from the dist. * doc/setting-up.txt: typo.
* Removed references to creating tables explicitely in favor ofOwen Taylor1999-08-021-44/+43
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Wed Aug 4 03:30:19 1999 Owen Taylor <otaylor@redhat.com> * doc/style-guide.txt: Removed references to creating tables explicitely in favor of demonstrating new syntax. Added a short section on /<* public >*/ and /*< private *>/. Wed Aug 4 03:15:19 1999 Owen Taylor <otaylor@redhat.com> * gtkdoc-mktmpl.in gtkdoc-mkhtml.in: Handle Struct and Enumerations in approximately the same way as we handle parameters. That is, instead of (as before) coding in the tables by hand, one uses lines like: @width: the width of the rectangle in pixels. To support migration from the older hand-coded tables, if none of the members of a structure or enumeration have a description in a @... line, then we don't generate the table at all. Also, gtkdoc-mktmpl now loads up the object heirarchy, because we need to be able to check if structures are widget structures. In general, the coding here is pretty clean, though the style is a little different. (I'm interating through strings with m/.../msg; instead of s/^...//; for one thing.) However, there are a some of FIXME's where I've whimped out on try to handle real C syntax, and the need to split out and librarize a bunch of duplicated code is greater than ever.
* updated version to 0.3.Damon Chaplin1999-06-062-10/+47
| | | | | | | | | | | 1999-06-06 Damon Chaplin <damon@karuna.freeserve.co.uk> * configure.in: updated version to 0.3. * doc/style-guide.txt: A couple of minor changes. * gtkdoc-mkdb.in: Get rid of a couple of messages. Output an empty <para> if an Arg isn't documented, to keep Jade happy.
* a few updates for 0.2Damon Chaplin1999-03-311-11/+94
| | | | a few updates for 0.2
* added *.argsDamon Chaplin1999-03-113-2/+120
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 1999-03-11 Damon Chaplin <damon@karuna.freeserve.co.uk> * examples/gnomeui/Makefile.am (clean-local): * examples/gnome/Makefile.am (clean-local): added *.args * gtkdoc-mkdb.in: added support for Args and variables. Also a few minor changes in the output, e.g. don't show macros > 2 lines long. * gtkdoc-mktmpl.in: * gtkdoc-scanobj.in: added support for Args. * gtkdoc-scan.in: added support for extern'ed variables. Also accept 'extern' before function declarations. * gtk-doc.dsl.in: made output prettier. Changed the navigation bars and the colours used for the various backgrounds. * doc/style-guide.txt: new file containinf a style guide for writing the GTK+ documentation. * doc/README: added description of style-guide.txt * doc/setting-up.txt: fixed a typo * README: added a bit about Args.
* ""Damon Chaplin1999-02-131-3/+2
|
* ""Damon Chaplin1999-01-281-6/+20
|
* ""Damon Chaplin1999-01-273-4/+111
|
* ""Damon Chaplin1999-01-251-0/+8
|
* ""Damon Chaplin1998-12-153-68/+78
|
* Updated to describe the new generic scripts instead of the old onesOwen Taylor1998-11-241-4/+3
| | | | | | | | Tue Nov 24 16:32:23 1998 Owen Taylor <otaylor@redhat.com> * README doc/authors.txt: Updated to describe the new generic scripts instead of the old ones hard-coded for GLIB and GTK+.
* Initial revisionOwen Taylor1998-11-247-0/+1004