summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* Have mm-common-prepare install the doc utilsDaniel Elstner2009-08-103-381/+0
| | | | | | | | | * configure.ac: Call MM_CONFIG_DOCTOOL_DIR([docs]) to set up the destination directory for mm-common-prepare to copy the documentation utilities to. * docs/doc-install.pl: Delete file. * docs/doc-postprocess.pl: ditto, * docs/tagfile-to-devhelp2.xsl: ditto.
* Use versioned directory for documentation toolsDaniel Elstner2009-08-101-1/+1
| | | | | | | * docs/Makefile.am (doctooldir): Use the versioned module name instead of the package name as $(datadir) subdirectory. * glib/glibmm-2.4.pc.in (doctooldir): Change the variable value accordingly.
* Provide documentation location via pkg-configDaniel Elstner2009-08-101-2/+6
| | | | | | | | | | | | | | | | | | | | | | | | * glib/glibmm-2.4.pc.in: Clean up and modernize the values, and make use of more configure variable substitutions. (datarootdir): Substitute @datarootdir@. (gmmprocdir): Remove the @GMMPROC_DIR@ substitution and expand ${libdir} indirectly. (doctooldir): New variable pointing to the location of the installed utilities for building the reference documentation. (docdir), (doxytagfile), (htmlrefdir), (htmlrefpub): Provide meta information on the installed reference documentation in these new pkg-config variables. * gio/giomm-2.4.pc.in: Clean up and modernize the values, and make use of more configure variable substitutions. (datarootdir): Substitute @datarootdir@. (docdir), (doxytagfile), (htmlrefdir), (htmlrefpub): Provide meta information on the installed reference documentation in these new pkg-config variables. The values are identical to the glibmm-2.4 ones because the documentation is bundled. * docs/Makefile.am (hmtlrefpub): Override the public web URL of the reference documentation, since the currently uploaded documentation still has the redundant docs/ component in the base path.
* Bring back the giomm reference documentationDaniel Elstner2009-08-091-1/+7
| | | | | | | | | | | | | | * glib/{src,glibmm}/filelist.am: Add namespace prefix glibmm_ to variable names, so that the file lists of glibmm and giomm can be included together without conflicts. * gio/{src,giomm}/filelist.am: Add namespace prefix giomm_ to variable names. * glib/{src,glibmm}/Makefile.am: Copy the namespace-prefixed make variables to non-prefixed variables, so that the Automake include files from mm-common will pick up the values. * gio/{src,giomm}/Makefile.am: ditto. * docs/Makefile.am: Include file lists of giomm. (doc_input): List the header files of both glibmm and giomm.
* Begin move to new documentation infrastructureDaniel Elstner2009-08-0912-89944/+567
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * configure.ac (AC_CONFIG_FILES): Remove the old build files docs/{images,internal,reference}/Makefile from the list. Also remove the obsolete docs/reference/beautify_docs.pl. * docs/Makefile.am: Big overhaul. Reimplement on top of the new documentation infrastructure provided with the mm-common module. Build, distribute and install files which used to be handled by the subdirectories' Makefiles directly from here. Note that the generated reference documentation at the moment only covers glibmm without giomm. Remedy follows. * docs/reference/Doxyfile.in: Replace configuration with the modernized version from librsvgmm, appropriately modified for glibmm. Make use of the new substitutions provided by the mm-common Autoconf magic. * docs/doc-install.pl: Copy script from mm-common. Install it into $(pkgdatadir)/doctool. * docs/doc-postprocess.pl: ditto, * docs/tagfile-to-devhelp2.xsl: ditto. * docs/images/Makefile.am: Delete subdirectory Makefile. * docs/internal/Makefile.am: ditto, * docs/reference/Makefile.am: ditto. * docs/reference/README: Delete file, as it documents exactly the things I just ripped. * docs/reference/beautify_docs.pl.in: Delete obsolete file. * docs/reference/doxygen_to_devhelp.xsl: ditto, * docs/reference/libstdc++.tag.xml: ditto.
* Gio::File::load_contents() override to allow ignoring the etag contents. ↵Hubert Figuiere2009-06-171-1/+2
| | | | (Bug #581349)
* Fix non-sourcedir build failureTheppitak Karoonboonyanan2009-05-161-1/+1
| | | | | | | Reference to generated beautify_docs.py in builddir, not srcdir. Bug #581319 Signed-off-by: Theppitak Karoonboonyanan <thep@linux.thai.net>
* Remove generated file from repositoryDaniel Elstner2009-03-231-81/+0
| | | | svn path=/trunk/; revision=802
* fix distcheckglibmm-2.19.3Jonathon Jongsma2009-02-211-3/+7
| | | | svn path=/trunk/; revision=787
* Allow pangomm to build outside the source tree. Bug #570216Theppitak Karoonboonyanan2009-02-052-4/+4
| | | | | | | | | | 2009-02-05 Theppitak Karoonboonyanan <thep@linux.thai.net> * docs/reference/Doxyfile.in: * docs/reference/Makefile.am: Allow pangomm to build outside the source tree. Bug #570216 svn path=/trunk/; revision=781
* rebuild docs when a giomm header file is changedJonathon Jongsma2008-12-121-1/+1
| | | | svn path=/trunk/; revision=756
* Change the Main Page link to link to gtkmm.org/documentation.shtmlMurray Cumming2008-08-021-2/+1
| | | | | | | | | 2008-08-02 Murray Cumming <murrayc@murrayc.com> * docs/reference/glibmm_header.html_fragment: Change the Main Page link to link to gtkmm.org/documentation.shtml svn path=/trunk/; revision=705
* update NEWS and version for new releaseglibmm-2.17.0Jonathon Jongsma2008-06-161-0/+0
| | | | svn path=/trunk/; revision=669
* 'upgraded' the doxygen config file since doxygen was complaining aboutJonathon Jongsma2008-02-261-95/+311
| | | | | | | | | | | | | | | * docs/reference/Doxyfile.in: 'upgraded' the doxygen config file since doxygen was complaining about obsolete options * gio/giomm/contenttype.h: * gio/src/bufferedinputstream.hg: * gio/src/file.hg: * gio/src/fileoutputstream.hg: * gio/src/outputstream.hg: * glib/src/checksum.hg: * glib/src/keyfile.hg: fixed a bunch of minor doxygen warnings svn path=/trunk/; revision=624
* add path separators between the reference prefix and the link filenamesJonathon Jongsma2008-02-262-6/+6
| | | | | | | | | | * docs/reference/doxygen_to_devhelp.xsl: add path separators between the reference prefix and the link filenames * docs/reference/Makefile.am: remove trailing slash from the reference prefix (fixes bug #518673) svn path=/trunk/; revision=623
* dist xml/index.xml to satisfy build-deps for building the devhelp bookJonathon Jongsma2008-02-241-1/+2
| | | | | | | * docs/reference/Makefile.am: dist xml/index.xml to satisfy build-deps for building the devhelp book from the tarball. Fixes distcheck. svn path=/trunk/; revision=619
* updated some build dependencies that were causing issues after adding theJonathon Jongsma2008-02-201-18/+15
| | | | | | | | | | * docs/reference/Makefile.am: updated some build dependencies that were causing issues after adding the xml/devhelp build rules. Also removed some cruft that was supposedly setting the doxygen image path for gtk stock icons (presumably copied from the gtkmm build rules). Should Fix Bug #517423 svn path=/trunk/; revision=607
* I should have tested this more thoroughly -- we apparently need to useJonathon Jongsma2008-02-161-2/+2
| | | | | | | | | | * docs/reference/Makefile.am: I should have tested this more thoroughly -- we apparently need to use relative paths in the reference_prefix variable. Also add the devhelp file to the all-local target so it gets built by default on a simple 'make' and not just on 'make install' svn path=/trunk/; revision=604
* install the stylesheet in the gmmproc dir instead of the documentationJonathon Jongsma2008-02-161-1/+2
| | | | | | | | | | | * docs/reference/Makefile.am: install the stylesheet in the gmmproc dir instead of the documentation directory. This allows other libraries to get a path to the stylesheet by querying the just-added gmmprocdir variable. Also, it doesn't really belong in the documentation directory since it's not technically documentation. svn path=/trunk/; revision=603
* make this more general instead of hard-coding the name and title andJonathon Jongsma2008-02-162-9/+19
| | | | | | | | | | | | | * docs/reference/doxygen_to_devhelp.xsl: make this more general instead of hard-coding the name and title and reference path into the stylesheet -- instead pass them as parameters on the commandline * docs/reference/Makefile.am: use new GMMPROC_DIR variable. Also install the doxygen_to_devhelp.xsl stylesheet so that other libraries can use the installed version instead of having everybody copy the file into their own library if they want to generate a devhelp book svn path=/trunk/; revision=602
* generate and install a devhelp book for glibmm like we do for gtkmm. ItJonathon Jongsma2008-02-143-3/+113
| | | | | | | | | | | * docs/reference/Doxyfile.in: * docs/reference/Makefile.am: * docs/reference/doxygen_to_devhelp.xsl: generate and install a devhelp book for glibmm like we do for gtkmm. It would be nice to make the xsl stylesheet general and shared between gtkmm and glibmm (and eventually other libraries as well), but for now I just duplicated it here svn path=/trunk/; revision=599
* Added class documentation.Murray Cumming2008-01-111-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 2008-01-11 Murray Cumming <murrayc@murrayc.com> * gio/src/appinfo.hg: Added class documentation. * gio/src/asyncresult.hg: * gio/src/cancellable.hg: * gio/src/drive.hg: * gio/src/file.hg: * gio/src/fileattribute.hg: * gio/src/fileenumerator.hg: * gio/src/fileicon.hg: * gio/src/fileinfo.hg: * gio/src/fileinputstream.hg: * gio/src/fileoutputstream.hg: * gio/src/icon.hg: * gio/src/inputstream.hg: * gio/src/loadableicon.hg: * gio/src/mountoperation.hg: * gio/src/outputstream.hg: * gio/src/seekable.hg: * gio/src/simpleasyncresult.hg: * gio/src/volume.hg: Added @newin2p16 to the documentation. * glib/src/Makefile_list_of_hg.am_fragment: * glib/src/uriutils.ccg: * glib/src/uriutils.hg: Added wrappers of (some) of these new g_uri_* functions. Not yet documented. svn path=/trunk/; revision=506
* :FormatStream::FormatStream): Use the global C++ locale instead of forcingDaniel Elstner2007-09-031-1/+2
| | | | | | | | | | | | | | | | | | | | | * glib/glibmm/ustring.cc (ustring::FormatStream::FormatStream): Use the global C++ locale instead of forcing the environment's locale onto the formatting stream. This lifts an unnecessary restriction at the cost of requiring users to call std::locale::global(). * glib/glibmm/ustring.h (ustring): Advertise the new compose and format API in the class documentation. (ustring::format): Correct a couple of cut'n'paste mistakes -- ouch. Also add two more overloads so that format() now takes up to eight arguments. Extent the method documentation, too. (ustring::Stringify): Explicitly declare the class as noncopyable. (ustring::compose): Qualify calls to method ustring::compose_argv() in order to avoid surprising name lookup results in the context of the template instantiation. * docs/reference/Doxyfile.in (PREDEFINED): Add GLIBMM_HAVE_WIDESTREAM so that the wide stream I/O operators show up in the documentation. svn path=/trunk/; revision=441
* added <div> to doxygen header and footer to make it easier to integrateJonathon Jongsma2007-08-162-0/+4
| | | | | | | | | * docs/reference/glibmm_footer.html_fragment, docs/reference/glibmm_header.html_fragment: added <div> to doxygen header and footer to make it easier to integrate with library.gnome.org, per a request by Frederic Peters svn path=/trunk/; revision=438
* Corrected the rsync options, to match those used by gtkmm, to fix theMurray Cumming2007-07-281-1/+1
| | | | | | | | | | 2007-07-28 Murray Cumming <murrayc@murrayc.com> * docs/Makefile_web.am_fragment: Corrected the rsync options, to match those used by gtkmm, to fix the examples upload. * glib/src/glib_docs.xml: Regenerated from the C documentation. svn path=/trunk/; revision=427
* convert_tags_to_doxygen(): Handle newin markers for 2.12 and a few afterMurray Cumming2007-07-021-0/+3
| | | | | | | | | | | 2007-07-02 Murray Cumming <murrayc@murrayc.com> * tools/pm/DocsParser.pm: convert_tags_to_doxygen(): Handle newin markers for 2.12 and a few after that. * docs/reference/Doxyfile.in: Added ALIASES for newin2p12 and a few more. svn path=/trunk/; revision=422
* Remove .cvsignore files.Daniel Elstner2007-01-204-14/+0
| | | | svn path=/trunk/; revision=367
* Updated from the libstdc++ site. Note that the original does not have anMurray Cumming2006-11-221-2031/+76425
| | | | | | | | 2006-11-20 Murray Cumming <murrayc@murrayc.com> * docs/reference/libstdc++.tag.xml: Updated from the libstdc++ site. Note that the original does not have an .xml extension. This is is lots bigger, but that should mean there is more documentation now.
* Add enum.pl to the dist, so that it is in tarballs. Someone saw itMurray Cumming2006-11-101-1/+1
| | | | | | | | 2006-11-10 Murray Cumming <murrayc@murrayc.com> * tools/Makefile.am: Add enum.pl to the dist, so that it is in tarballs. Someone saw it mentioned in the appendix, but could not find it in the tarball.
* Add PREDEFINES for the optional API, so that the documentation shows theMurray Cumming2006-11-101-1/+6
| | | | | | | 2006-11-10 Murray Cumming <murrayc@murrayc.com> * docs/reference/Doxyfile.in: Add PREDEFINES for the optional API, so that the documentation shows the regular API.
* Add a silly line to avoid unused parameters when GLIBMM_EXCEPTION_ENABLEDMurray Cumming2006-10-041-1/+1
| | | | | | | | | | | 2006-10-04 Murray Cumming <murrayc@murrayc.com> * glib/glibmm/class.cc: * glib/src/iochannel.ccg: * glib/src/markup.ccg: Add a silly line to avoid unused parameters when GLIBMM_EXCEPTION_ENABLED is not set. * glib/glibmm/error.h: Do not use G_GNU_NO_RETURN on the version of throw_exception() that returns, to avoid a warning.
* Upload to the new hoster instead of to sourceforge. Abstracted the hostMurray Cumming2006-10-015-7/+8
| | | | | | | | | | | | | | 2006-10-01 Murray Cumming <murrayc@murrayc.com> * Makefile.am: * docs/Makefile.am: * docs/Makefile_web.am_fragment: * docs/images/Makefile.am: * docs/reference/Makefile.am: * docs/reference/README: * examples/Makefile.am: Upload to the new hoster instead of to sourceforge. Abstracted the host and path names into docs/Makefile_web.am_fragment to avoid duplication.
* rebuild docs when a .h files changes in glib/glibmmJonathon Jongsma2006-09-101-1/+1
| | | | | | | | | | 2006-09-05 Jonathon Jongsma <jonathon.jongsma@gmail.com> * docs/reference/Makefile.am: rebuild docs when a .h files changes in glib/glibmm * glib/glibmm/miscutils.cc: * glib/glibmm/miscutils.h: wrap g_get_user_data_dir(), g_get_user_config_dir(), and g_get_user_cache_dir()
* Parse a new optional constversion parameter for _WRAP_METHOD(), to save onMurray Cumming2006-04-121-0/+5
| | | | | | | | | | | 2006-04-12 Murray Cumming <murrayc@murrayc.com> * tools/pm/WrapParser.pm: Parse a new optional constversion parameter for _WRAP_METHOD(), to save on code size by just calling the non-const overload instead of generating almost identical code. * tools/m4/method.m4: _METHOD(): Take extra parameters for use when constversion is used. * tools/pm/Output.pm: Send the extra parameters to _METHOD(). * docs/internal/using_gmmproc.txt: Documented the new constversion option.
* Merge in changes from glibmm 2.8 branch. These are documentation and build ↵Murray Cumming2006-03-081-0/+3
| | | | fixes, allowed during the hard code freeze.
* Fix the link to the Main page. Bug #328299.Rob Page2006-01-281-2/+2
| | | | | | | 2006-01-28 Rob Page <rob@gmail.com> * docs/reference/glibmm_header.html_fragment: Fix the link to the Main page. Bug #328299.
* Define the @newin aliases, as in gtkmm. Convert Since: in gtk-doc text toMurray Cumming2005-11-301-1/+5
| | | | | | | | | 2005-11-30 Murray Cumming <murrayc@murrayc.com> * docs/reference/Doxyfile.in: Define the @newin aliases, as in gtkmm. * tools/pm/DocsParser.pm: Convert Since: in gtk-doc text to @newin for our doxygen docs.
* Use g_param_spec_get_blurb() to output the documentation for theMurray Cumming2005-02-131-1/+1
| | | | | | | | | | | | | | 2005-02-13 Murray Cumming <murrayc@murrayc.com> * tools/extra_defs_gen/generate_extra_defs.cc: Use g_param_spec_get_blurb() to output the documentation for the properties in the .defs file. * tools/m4/property.m4: Take an extra docs argument, and put it in the doxygen docs. * tools/pm/Output.pm: Add the extra docs argument when calling the property m4 macro. * tools/pm/Property.pm: Read in the new docs part of the .defs, and add a period at the end if neccessary.
* Added a copy of the libstdc++ doxygen tags file, but it still does notMurray Cumming2004-12-192-1/+14060
| | | | | | | | 2004-12-19 Murray Cumming <murrayc@murrayc.com> * docs/reference/: Added a copy of the libstdc++ doxygen tags file, but it still does not seem to work, for example with std::vector<> and std::string.
* Use the libstdc++ TAG files, so that references to std:: classes takeMurray Cumming2004-12-191-1/+1
| | | | | | | | | 2004-12-19 Murray Cumming <murrayc@murrayc.com> * docs/reference/Doxyfile.in: Use the libstdc++ TAG files, so that references to std:: classes take people to their docs. * glib/src/: Added glib_docs.xml and glib_docs_override.xml, and mentioned them in Makefile.am.
* Documented the constructors, based on the libstdc++ documentation, to makeMurray Cumming2004-05-041-1/+1
| | | | | | | | 2004-05-04 Murray Cumming <murrayc@murrayc@murrayc.com> * glib/glibmm/ustring.h: Documented the constructors, based on the libstdc++ documentation, to make it clear that sizes are in characters rather than bytes.
* Make the generated html depend on the beautify_docs.pl.in source insteadMurray Cumming2004-04-171-1/+2
| | | | | | | | 2004-04-17 Murray Cumming <murrayc@murrayc.com> * docs/reference/Makefile.am: Make the generated html depend on the beautify_docs.pl.in source instead of the generated beautify_docs.pl, so that the html is not rebuilt from tarballs.
* 2.4.0:Murray Cumming2004-04-111-1/+1
| | | | | | | | 2004-04-11 Murray Cumming <murrayc@murrayc.com> * tools/pm/WrapParser.pm, Output.pm, m4/signal.m4: Allow _WRAP_SIGNAL() to take an refreturn argument, so that Gtk::Widget::on_get_accessible() can do an extra ref before returning the Atk::Object.
* Another change to give better warnings and errors at gmmproc-runtime.Hagen Moebius2004-03-091-0/+1
| | | | | | | | | 2004-04-08 Hagen Moebius <hagen.moebius@starschiffchen.de> * tools/pm/DocsParser.pm: Another change to give better warnings and errors at gmmproc-runtime. Further improvment of parsing parameter names to strip traling underscres. This not only for reference text, but for the parameter list also.
* Updated some .cvsignore filesMurray Cumming2004-03-051-3/+3
|
* Added missing file.Murray Cumming2003-12-301-0/+81
|
* generate beautify_docs.pl from beautify_docs.pl.in, so it can have theMurray Cumming2003-12-222-2/+7
| | | | | | | | 2003-12-22 Murray Cumming <murrayc@usa.net> * docs/reference: generate beautify_docs.pl from beautify_docs.pl.in, so it can have the perl path in it. Install it, so other *mm modules can use it.
* Added WRAP_METHOD_DOCS_ONLY() macro. Explained the new macro.Murray Cumming2003-11-281-0/+10
| | | | | | | | 2003-11-27 Murray Cumming <murrayc@usa.net> * tools/pm/WrapParser.pm, Output.pm: Added WRAP_METHOD_DOCS_ONLY() macro. * docs/internal/using_gmmproc.txt: Explained the new macro.
* added missing files.Murray Cumming2003-10-312-0/+0
|
* Corrected install location, so that links from the gtkmm docs work whenMurray Cumming2003-10-311-1/+1
| | | | | | | 2003-10-31 Murray Cumming <murrayc@usa.net> * docs/Makefile_web.am_fragment: Corrected install location, so that links from the gtkmm docs work when they are installed.
View Lorry Controller Status