NEWS

   1
   2
   3 GTK-Doc 1.8     (Feb 16 2007)
   4 ===========
   5
   6  o Made it easier to include example code in the source code comment blocks.
   7    "|[ ... ]|" can be used to delineate example code (it just gets converted
   8    to "<informalexample><programlisting>"), and most of the text in example
   9    code is left as it is. The only thing that is still expanded is
  10    '#' to allow links to a symbol's documentation, e.g. '#GtkWidget'.
  11  o Made the field widths wider for the HTML output, so it looks a bit nicer.
  12  o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild
  13    the MODULE-sections.txt file. This only works if all the header files are
  14    organized neatly and functions don't need rearranging in the docs.
  15  o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild
  16    the MODULE.types file, so you don't need to add new types manually.
  17  o Leave CDATA sections as they are, in the extra XML content files and within
  18    source code comment blocks.
  19  o Allow the section id and #include's to be set within the "SECTION:" comment
  20    block, using "@Section_ID:xxx" and "@Include:".
  21  o Added "--default-includes" option to specify the default #include's (for
  22    people who are using --rebuild-sections and so can't specify it in
  23    MODULE-sections.txt).
  24  o Added a '--query-child-properties' argument to help document child
  25    properties of arbitrary GObjects (used by things like canvas widgets).
  26  o Fixed documentation of signals of interfaces.
  27
  28
  29 GTK-Doc 1.7     (Jul 29 2006)
  30 ===========
  31
  32  o Fixed bug that resulted in empty "@:" lines in the templates.
  33  o Fixed a few bugs with the XSL code.
  34  o Supported a few more variations of C syntax.
  35  o Remove the internally-used '-struct' suffix from links to widget structs.
  36  o Fixed a few missing build dependencies.
  37  o Added a new "C-x4s" binding to the emacs lisp code, to insert a blank
  38    section header in the source code.
  39  o Fixed bug that ignored inline section header docs with '-' in their names.
  40  o Added a 'make docs' target that can be used to build the docs even when
  41    gtk-doc has been disabled at configure time.
  42
  43
  44 GTK-Doc 1.6     (Apr 9 2006)
  45 ===========
  46
  47  o Removed the hard dependancy on openjade or jade, since XML is used mainly
  48    now rather than SGML.
  49  o Install the .pc file in $(datadir) rather than $(libdir) since gtk-doc is
  50    architecture-independant.
  51  o Added "--ignore-decorators" option to ignore a list of declarators in
  52    function declarations.
  53  o Support '#Object::signal'/'#Object:property' to link to signals/properties
  54  o Fixed missing index terms.
  55
  56
  57 GTK-Doc 1.5     (Mar 7 2006)
  58 ===========
  59
  60  o Output the new version of devhelp2 information, but still generate the old
  61    devhelp files so older versions of DevHelp still work OK.
  62  o Fixed the initial creation of the *-sections.txt file so the object
  63    hierarchy, signals and properties all work automatically.
  64  o Show information about signal flags (run first/last).
  65  o Support a --source-suffixes argument specifying which source files to scan.
  66  o Support other root object types besides GObject and GInterface.
  67  o Use a fixed navigation bar for the generated documentation.
  68  o New documentation from Stefan Kost.
  69  o Handle more variations of C syntax.
  70
  71
  72 GTK-Doc 1.4     (Jul 3 2005)
  73 ===========
  74
  75  o Support section documentation (title, short description, long description
  76    and 'see also') within the source code. I think everything can now be
  77    documented within the source code.
  78  o Support Stable/Unstable/Private stability levels for everything.
  79
  80
  81 GTK-Doc 1.3     (Jan 9 2005)
  82 ===========
  83
  84  o Use the new style.css stylesheet instead of hard-wiring the styles.
  85  o Updated the documentation and example build files.
  86  o Added support for a gallery of widget images.
  87  o Output default values for widget properties and allowed ranges.
  88  o Only underline links in the docs when the mouse hovers over them.
  89  o Added support for placing the parameter table anywhere within the function
  90    documentation (using the "<!--PARAMETERS-->" marker).
  91  o Handle more variations of C syntax.
  92
  93
  94 GTK-Doc 1.2     (Feb 16 2004)
  95 ===========
  96
  97  o Added widget signals and properties to undocumented output and statistics.
  98  o Added support for an index of all symbols.
  99  o Emit "Since:" information for signals and properties.
 100  o Added derived subclasses and interfaces to the widget hierarchies.
 101  o Added .cat SGML catalog file.
 102  o Support properties on interfaces.
 103  o Added "--help" options to the scripts.
 104
 105
 106 GTK-Doc 1.1     (Apr 18 2003)
 107 ===========
 108
 109  o Add a gtk-doc.m4 macro that allows packages to provide consistent
 110    checking for gtk-doc.
 111  o Check to make sure that the XML catalog actually contains entries
 112    for the DocBook XML DTD and XSLT stylesheets.  Please consult the
 113    README file if your system's XML catalog isn't set up.
 114  o Add infrastructure for including the standard gtk-doc makefile
 115    glue, so that maintainers of packages don't need to worry about
 116    keeping it up to date.  See glib head for an example of its use.
 117  o Some updates to the devhelp contents file generation, as suggested
 118    by Hallski.
 119  o Fix some bugs in the DocBook XML codepath that were preventing
 120    inter-module cross references from being resolved.
 121  o Fix some bugs in extraction of object property documentation.
 122
 123
 124 GTK-Doc 1.0     (Jan 20 2003)
 125 ===========
 126
 127  o Added support for "Since:" and "Deprecated:" tags, and look for deprecated
 128    guard macros in header files.
 129  o Support /*< public >*/ and /*< private >*/ markers for all structs.
 130  o New "--ignore-files" option for gtkdoc-mkdb, to ignore files or directories.
 131  o Used the "sgml-raw" output type with openjade, to avoid problems with Lynx.
 132  o Added .pc pkg-config file which can be used to check the gtk-doc version.
 133
 134
 135 GTK-Doc 0.10    (Nov 14 2002)
 136 ============
 137
 138  o --output-format option to select whether SGML or XML is generated.
 139  o Use openjade or jade when converting SGML to HTML.
 140  o Use xsltproc to convert XML to HTML, with a new look.
 141  o In XML mode, support XIncludes as an alternative to entities.
 142  o In XML mode, create .devhelp files.
 143  o List interfaces in the object hierarchy.
 144  o Create docs for signals on interfaces.
 145  o Generate links between interface and their implementations and
 146    prerequisites.
 147  o Create docs for child and style properties.
 148  o Use blurbs for property documentation.
 149  o Allow inline documentation for signals and properties.