summaryrefslogtreecommitdiff
path: root/textproc/gtk-doc
AgeCommit message (Collapse)AuthorFilesLines
2007-04-10update to 1.8drochner3-11/+16
pkgsrc change: make SGML output optional, off per default, which saves the heavyweight dependency on jade other changes: o Made it easier to include example code in the source code comment blocks. "|[ ... ]|" can be used to delineate example code (it just gets converted to "<informalexample><programlisting>"), and most of the text in example code is left as it is. The only thing that is still expanded is '#' to allow links to a symbol's documentation, e.g. '#GtkWidget'. o Made the field widths wider for the HTML output, so it looks a bit nicer. o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild the MODULE-sections.txt file. This only works if all the header files are organized neatly and functions don't need rearranging in the docs. o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild the MODULE.types file, so you don't need to add new types manually. o Leave CDATA sections as they are, in the extra XML content files and within source code comment blocks. o Allow the section id and #include's to be set within the "SECTION:" comment block, using "@Section_ID:xxx" and "@Include:". o Added "--default-includes" option to specify the default #include's (for people who are using --rebuild-sections and so can't specify it in MODULE-sections.txt). o Added a '--query-child-properties' argument to help document child properties of arbitrary GObjects (used by things like canvas widgets). o Fixed documentation of signals of interfaces.
2006-08-06Update to 1.7:jmmv2-7/+7
o Fixed bug that resulted in empty "@:" lines in the templates. o Fixed a few bugs with the XSL code. o Supported a few more variations of C syntax. o Remove the internally-used '-struct' suffix from links to widget structs. o Fixed a few missing build dependencies. o Added a new "C-x4s" binding to the emacs lisp code, to insert a blank section header in the source code. o Fixed bug that ignored inline section header docs with '-' in their names. o Added a 'make docs' target that can be used to build the docs even when gtk-doc has been disabled at configure time. (Yeah, I know I updated it to 1.6 earlier today... thanks to wiz@ for pointing out the newest version.)
2006-08-06Update to 1.6:jmmv3-10/+9
o Removed the hard dependancy on openjade or jade, since XML is used mainly now rather than SGML. o Install the .pc file in $(datadir) rather than $(libdir) since gtk-doc is architecture-independant. o Added "--ignore-decorators" option to ignore a list of declarators in function declarations. o Support '#Object::signal'/'#Object:property' to link to signals/properties o Fixed missing index terms.
2006-07-08Change the format of BUILDLINK_ORDER to contain depth information as well,jlam1-2/+2
and add a new helper target and script, "show-buildlink3", that outputs a listing of the buildlink3.mk files included as well as the depth at which they are included. For example, "make show-buildlink3" in fonts/Xft2 displays: zlib fontconfig iconv zlib freetype2 expat freetype2 Xrender renderproto
2006-07-08Track information in a new variable BUILDLINK_ORDER that informs usjlam1-1/+2
of the order in which buildlink3.mk files are (recursively) included by a package Makefile.
2006-04-06Over 1200 files touched but no revisions bumped :)reed1-2/+2
RECOMMENDED is removed. It becomes ABI_DEPENDS. BUILDLINK_RECOMMENDED.foo becomes BUILDLINK_ABI_DEPENDS.foo. BUILDLINK_DEPENDS.foo becomes BUILDLINK_API_DEPENDS.foo. BUILDLINK_DEPENDS does not change. IGNORE_RECOMMENDED (which defaulted to "no") becomes USE_ABI_DEPENDS which defaults to "yes". Added to obsolete.mk checking for IGNORE_RECOMMENDED. I did not manually go through and fix any aesthetic tab/spacing issues. I have tested the above patch on DragonFly building and packaging subversion and pkglint and their many dependencies. I have also tested USE_ABI_DEPENDS=no on my NetBSD workstation (where I have used IGNORE_RECOMMENDED for a long time). I have been an active user of IGNORE_RECOMMENDED since it was available. As suggested, I removed the documentation sentences suggesting bumping for "security" issues. As discussed on tech-pkg. I will commit to revbump, pkglint, pkg_install, createbuildlink separately. Note that if you use wip, it will fail! I will commit to pkgsrc-wip later (within day).
2006-03-31Register the installed documentation in the scrollkeeper database.jmmv2-3/+13
This is to add an explicit dependency on this utility so that gtk-doc does not install unmanaged files when scrollkeeper is already installed. Bump PKGREVISION to 2.
2006-03-21Bump PKGREVISION for all packages that had broken INSTALL/DEINSTALLjlam1-1/+2
scripts prior to revision 1.43 of bsd.pkginstall.mk.
2006-03-08Update to 1.5:wiz3-9/+9
GTK-Doc 1.5 (Mar 7 2006) =========== o Output the new version of devhelp2 information, but still generate the old devhelp files so older versions of DevHelp still work OK. o Fixed the initial creation of the *-sections.txt file so the object hierarchy, signals and properties all work automatically. o Show information about signal flags (run first/last). o Support a --source-suffixes argument specifying which source files to scan. o Support other root object types besides GObject and GInterface. o Use a fixed navigation bar for the generated documentation. o New documentation from Stefan Kost. o Handle more variations of C syntax.
2006-03-04Point MAINTAINER to pkgsrc-users@NetBSD.org in the case where nojlam1-2/+2
developer is officially maintaining the package. The rationale for changing this from "tech-pkg" to "pkgsrc-users" is that it implies that any user can try to maintain the package (by submitting patches to the mailing list). Since the folks most likely to care about the package are the folks that want to use it or are already using it, this would leverage the energy of users who aren't developers.
2006-02-26Add buildlink3 file, defaulting to build dependency.wiz1-0/+22
Intended to be used by packages that look for gtk-doc using pkg-config.
2006-02-05Recursive revision bump / recommended bump for gettext ABI change.joerg1-1/+2
2006-01-20Drop maintainership. I can't seriously be the maintainer of so manyjmmv1-2/+2
packages - specially of packages that I haven't touched for a long while or those that other people can handle better than me.
2005-12-05Ran "pkglint --autofix", which corrected some of the quoting issues inrillig1-2/+2
CONFIGURE_ARGS.
2005-10-08Update to 1.4:jmmv2-8/+8
o Use the new style.css stylesheet instead of hard-wiring the styles. o Updated the documentation and example build files. o Added support for a gallery of widget images. o Output default values for widget properties and allowed ranges. o Only underline links in the docs when the mouse hovers over them. o Added support for placing the parameter table anywhere within the function documentation (using the "<!--PARAMETERS-->" marker). o Handle more variations of C syntax.
2005-07-16Remove some unnecessarily strong dependencies on perl that resultedjlam1-2/+2
from including perl5/buildlink3.mk. These packages just need the Perl interpreter, and can just add "perl" to USE_TOOLS instead.
2005-04-30Given that I've done all the latest updates, pick up maintainership.jmmv1-2/+2
Requested by the current maintainer, schmonz@.
2005-04-11Remove USE_BUILDLINK3 and NO_BUILDLINK; these are no longer used.tv1-2/+1
2005-03-22Update to 1.3:jmmv3-10/+13
GTK-Doc 1.3 (Jan 9 2005) =========== o Use the new style.css stylesheet instead of hard-wiring the styles. o Updated the documentation and example build files. o Added support for a gallery of widget images. o Output default values for widget properties and allowed ranges. o Only underline links in the docs when the mouse hovers over them. o Added support for placing the parameter table anywhere within the function documentation (using the "<!--PARAMETERS-->" marker). o Handle more variations of C syntax.
2005-02-24Add RMD160 digests to the SHA1 ones.agc1-1/+2
2004-10-03Libtool fix for PR pkg/26633, and other issues. Update libtool to 1.5.10tv1-2/+2
in the process. (More information on tech-pkg.) Bump PKGREVISION and BUILDLINK_DEPENDS of all packages using libtool and installing .la files. Bump PKGREVISION (only) of all packages depending directly on the above via a buildlink3 include.
2004-07-06bump PKGREVISIONs since libxslt needs libgcrypt nowrecht1-1/+2
2004-04-26bl3ifyrecht1-5/+5
2004-04-26Unused.wiz1-19/+0
2004-02-19Bump version to 1.2.jmmv1-2/+2
2004-02-19Update to 1.2:jmmv3-8/+14
2004-02-16 Damon Chaplin <damon@gnome.org> * Released 1.2. 2004-02-16 Damon Chaplin <damon@gnome.org> * gtk-doc.cat.in: removed public ID for gtk-doc.dtd, since we don't use it any more. Sat Feb 14 02:14:27 2004 Matthias Clasen <maclas@gmx.de> * gtk-doc.m4: Avoid unnecessary checks if gtk-doc is disabled. (#134221, Julio M. Merino Vidal) Sat Feb 14 02:03:01 2004 Matthias Clasen <maclas@gmx.de> * gtk-doc.make: Don't create unneeded empty directories. (#134319, Julio M. Merino Vidal) Sat Feb 14 01:37:38 2004 Matthias Clasen <maclas@gmx.de> * gtk-doc.make: Add an empty all-local target to make it work with non-GNU make. (#134343, Julio M. Merino Vidal) Wed Jan 28 00:52:00 2004 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (OutputObjectList): Avoid emitting invalid docbook markup if there are no objects. Partial fix for #132661. Sun Jan 25 22:01:15 2004 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in: Accept both the old and the new XInclude namespace. (#131675, Edd Dumbill) 2004-01-23 Thomas Vander Stichele <thomas at apestaart dot org> * gtkdoc-mkhtml.in: exit when tools return non-zero so errors can be caught. Thu Jan 15 23:06:10 2004 Matthias Clasen <maclas@gmx.de> * gtk-doc.xsl: Set the chunk.fast parameter, to gain some speed. Thu Jan 15 23:05:23 2004 Matthias Clasen <maclas@gmx.de> * gtkdoc-fixxref.in: Make it work again without explicit --module. Sat Dec 27 01:36:08 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-scangobj.in: * gtkdoc-mktmpl.in: * gtkdoc-scan.in: * gtkdoc-fixxref.in: Add --help. (#126915) Sat Dec 27 00:43:42 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (ParseEnumDeclaration): * gtkdoc-mktmpl.in (ParseEnumDeclaration): Support a trailing , in enum declarations. These are a GNU C extension, but also blessed by C99. (#129949, Thomas Vander Stichele) Sun Nov 16 00:29:03 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-scangobj.in: Don't use g_strdown(). (#127028, David Schleef) Sun Nov 16 00:26:05 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-scangobj.in: If compiled against GLib >= 2.3.0, look for properties on interfaces. (#127068, James M. Cape) 2003-11-03 Dan Winship <danw@ximian.com> * gtkdoc-scangobj.in: Clean up $MODULE-scan.o even when using libtool * gtkdoc-scanobj.in: Likewise * gtk-doc.make (CLEANFILES): Remove $(MODULE)-scan.o from here (clean-local): rm -rf .libs Wed Oct 8 01:21:54 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-scan.in (ScanHeader): Make gtkdoc-scan grok typedef struct { } foo; in addition to the more baroque typedef struct _foo foo; struct _foo { }; (#116807, Malcolm Tredinnick) Wed Oct 8 01:21:35 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (OutputParamDescriptions): Remove a pointless warning. 2003-10-01 Matthias Clasen <maclas@gmx.de> Make signals and properties end up in the right template file (#116569, Owen Taylor): * gtkdoc-mktmpl.in (OutputSignalTemplates): (OutputArgTemplates): Return a string rather than directly writing to OUTPUT. (OutputTemplateFile): Don't interpret $title as the name of the object to print signal and property templates for. (UpdateTemplates): Collect signal and property templates for all objects contained in the section. 2003-08-10 James Henstridge <james@daa.com.au> * acinclude.m4 (JH_PATH_XML_CATALOG): allow caller to specify actions if found or not found. (JH_CHECK_XML_CATALOG): when requiring JH_PATH_XML_CATALOG, don't error out if it is not found. 2003-08-03 Matthias Clasen <maclas@gmx.de> * doc/gnome.txt: Add some hints regarding markup of examples. 2003-07-22 Matthias Clasen <maclas@gmx.de> * configure.in: * gtk-doc.cat: Fix a problem with the previous commit. 2003-07-21 Matthias Clasen <maclas@gmx.de> Applied patches from Sebastian Rittau to add maintainer mode and an SGML catalog. (#117955, #117956) * gtk-doc.cat.in: New catalog file. * configure.in: Added gtk-doc.catalog to output files. * Makefile.am: Install gtk-doc.catalog. * configure.in: Added AM_MAINTAINER_MODE. * autogen.sh: Added --enable-maintainer-mode to configure options. 2003-07-09 Matthias Clasen <maclas@gmx.de> * gtkdoc-mktmpl.in (ParseStructDeclaration): * gtkdoc-mkdb.in (ParseStructDeclaration): Accept volatile struct members, which have just made their appearance in glib. 2003-06-29 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (ExpandAbbreviations): When expanding @param, catch the common @param->field and @param.field, to reduce the need for littering the C sources with <literal>foo->bar</literal>. 2003-06-25 Matthias Clasen <maclas@gmx.de> Changes for #115528: * gtkdoc-mkdb.in (OutputSGML): Collect hierarchy, interfaces, implementations, prerequisites and derived interfaces separately. (OutputSGMLFile): Take two more arguments: implementations and derived interfaces. (GetHierarchy): Also put immediate children in the local tree. (GetInterfaces): Split into GetInterfaces and GetImplementations. (GetImplementations): New function to get the implementations of an interface. (GetDerived): New function to get the known derived interfaces of an interface. * gtkdoc-mkdb.in (MakeXRef): Accept a second, optional parameter for the text of the link. (ExpandAbbreviations): Add semantic markup inside the links, so that non-crossreferenced symbols come out properly formatted after link removal. (#61345) 2003-06-15 Matthias Clasen <maclas@gmx.de> Support for a flat index of all symbols. (#92861) To use, put an empty <index/> element in your driver document. * gtkdoc-mkdb.in (MakeIndexterms): New function, emits an indexterm. (OutputMacro, OutputTypedef, OutputStruct, OutputEnum, OutputUnion, OutputVariable, OutputFunction): Use MakeIndexterms. to emit indexterms for symbols. * gtkdoc-mkdb.in (GetSignals): (GetArgs): Emit Since: information for signals and properties. Thu Jun 12 15:55:57 2003 Owen Taylor <otaylor@redhat.com> * gtkdoc-mkhtml.in (declaration): Replace head -1 with -n 1. (Merge change by Elliot Lee from Red Hat package) 2003-06-11 Matthias Clasen <maclas@gmx.de> * doc/gnome.txt: Updates to the documentation of inline comments. 2003-06-03 Matthias Clasen <maclas@gmx.de> * gtk-doc.spec.in: Add a missing Provides: and include the .pc file. (#106568, Joe Pranevich) 2003-05-27 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (GetSignals): (GetArgs): Add signals and properties to the statistics. (OutputMissingDocumentation): Emit undocumented signals and properties. (#113645) 2003-04-21 Matthias Clasen <maclas@gmx.de> * tools/docpercentages.pl: Fix autolinkification for undocumented symbols. * doc/style-guide.txt: Typo fix.
2004-02-14PKGCONFIG_OVERRIDE is relative to WRKSRC.jmmv1-2/+2
2004-02-12Update to 1.1:jmmv4-20/+26
2003-04-18 James Henstridge <james@daa.com.au> * NEWS: add news items. * configure.in: increment version number. 2003-03-14 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (OutputBook): Fix the public identifier for DocBook V3.0: Davenport, not DavenPort. (#108343, Mariano Suarez-Alvarez) 2003-03-10 James Henstridge <james@daa.com.au> * configure.in: associate the chmod commands with the files they are chmod'ing. This way config.status will always run the correct chmod command. 2003-03-04 James Henstridge <james@daa.com.au> * configure.in: look up the docbook DTD by public id rather than system id. 2003-02-26 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (GetArgs): Prefer template or comment docs over blurbs only if they're nonempty, otherwise the empty docs from the templates override all the blurbs. 2003-02-26 James Henstridge <james@daa.com.au> * autogen.sh (THEDIR): set up so that it will choose automake 1.7 or 1.6 in preference to 1.4. Passes distcheck okay. * configure.in: update configure.in script to match recommendations of newer autoconf's, and add an AC_PREREQ() statement, since the xml catalog checks are using new autoconf features. * gtk-doc.make (xml-build.stamp): since other bits of the makefile were assuming xml, may as well hard code --output-format=xml. 2003-02-19 James Henstridge <james@daa.com.au> * Makefile.am: get rid of the dist-hook, and just include the given files in EXTRA_DIST instead. * configure.in: provide meaningful names for the commands. * acinclude.m4 (JH_CHECK_XML_CATALOG): add some extra arguments: a friendly name for the catalog entry, and actions to run if the entry was found or not. Also include a bit more information in the config.log file if an error occurs. 2003-02-18 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkhtml.in (declaration): Avoid the unportable grep option -q. (#105311) 2003-02-19 James Henstridge <james@daa.com.au> * devhelp.xsl: put chapters that aren't at the top level into the toc tree (to make gtk's .devhelp tree look better). * gtk-doc.spec.in (Requires): make the requires lines match current requirements ... * gtkdoc-mkhtml.in (XSLTPROC): pass --nonet to xsltproc, so we don't try to download DTDs and XSLT over the net. The configure checks should catch people who don't have the correct files in their catalog. 2003-02-17 James Henstridge <james@daa.com.au> * gtkdocize.in (--version): add --version argument. 2003-02-14 James Henstridge <james@daa.com.au> * gtkdoc-mkdb.in (GetOptions): actually accept --tmpl-dir as a command line option. Based on a patch from Simon Josefsson <jas@extundo.com>. * gtk-doc.xsl: remove the xmlns declaration. Not really needed for html output anyway ... 2003-02-13 James Henstridge <james@daa.com.au> * devhelp.xsl: remove refsect1's and refsect2's from book tree, as suggested by Hallski. * gtk-doc.make (install-data-local): the change to install images was superfluous, so I have removed it. (CLEANFILES): move some more stuff to CLEANFILES from the distclean-local rule. 2003-02-12 James Henstridge <james@daa.com.au> * gtk-doc.make: add some chmod calls to work arround distcheck on automake >= 1.6. (install-data-local): copy the images as well as the html files during install. (uninstall-local): add an uninstall rule to remove the docs. (CLEANFILES): add $(DOC_MODULE)-scan.o to the list of files to be cleaned up. 2003-02-09 James Henstridge <james@daa.com.au> * gtkdocize.in: script used to copy gtk-doc.make into another module. * gtk-doc.make: automake makefile fragment to handle gtk-doc support in other modules. * configure.in: check to make sure DocBook XML DTD and XSLT stylesheets are present in the XML catalog. * acinclude.m4 (JH_CHECK_XML_CATALOG): new macro to check for entries in the XML catalog. 2003-02-04 James Henstridge <james@daa.com.au> * gtk-doc.m4: a macro to check for gtk-doc. * Makefile.am (gtkdocdata_DATA): don't bother installing xml.dcl. It isn't used anymore (since switching xml mode to xsltproc). * gtkdoc-mkhtml.in (gtkdocdir): and here. * Makefile.am (gtkdocdatadir): change dir. * configure.in: put data files in $(datadir)/gtk-doc/data, so that they don't all get mixed up with the html docs installed by other packages.
2004-02-11Update to 1.0. This version includes lots of changes WRT 0.9. Some of themjmmv4-12/+22
are the inclusion of a pkg-config file, and support to convert documentation from XML to XHTML using xsltproc. Bug fixes, too.
2003-07-21COMMENT should start with a capital letter.martti1-2/+2
2003-07-17s/netbsd.org/NetBSD.org/grant1-2/+2
2003-04-30Unconditionally remove the share/gtk-doc directory. No other packages arejmmv1-2/+2
using it.
2002-09-21Use buildlink2.jlam1-2/+3
2002-09-14Add a buildlink2.mk defaulting to a build dependencyrh1-0/+19
2002-07-26Don't @dirrm share/gtk-doc, it's shared with other packages that don'twiz1-2/+2
depend on this one (e.g., devel/atk, devel/pango).
2002-07-22Update my email address.schmonz1-2/+2
2002-02-05Updated gtk-doc to 0.9 (privided by Amitai Schlair in pkg/15484)martti2-5/+5
* examples/Makefile.am: added SCANOBJ_OPTIONS in case the module needs to pass options to gtkdoc-scanobj or gtkdoc-scangobj. * tools/gtk-doc.el: added Zucchi's emacs lisp for automatically adding skeleton comment blocks above functions. Very handy! * gtkdoc-scangobj.in: we now default to calling g_type_init() to initialize the type system, rather than gtk_init(). This means you don't need an X connection to build the docs any more. Hurrah! Also added a '--type-init-func' argument so you can change the function to be called. GTK+ uses --type-init-func="gtk_type_init(0)". * gtkdoc-scan.in (ScanHeader): removed 'Found object' debug message.
2002-01-31Added gtk-doc-0.8 (provided by Amitai Schlair in pkg/15071)martti4-0/+43
The GTK+ Reference Documentation Project (RDP) aims to provide a complete set of reference material for the GLib, GDK, and GTK+ libraries. It is created using the gtk-doc system, which parses C header files and creates 'template' files which are then filled in by the authors. These template files are then converted into DocBook SGML, and from there to HTML or printed output.