summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Doxyfile.in: Don't hide undocumented classesKjell Ahlstedt2023-02-221-2/+2
| | | | | Might make the inheritance diagrams less incomplete when Doxygen's tag files are not perfect.
* Doxyfile.in: Allow more graph nodesKjell Ahlstedt2022-10-101-1/+1
| | | | Required for Glib::Object's inheritance diagram.
* Doxyfile.in: Remove obsolete entryKjell Ahlstedt2022-08-221-1/+0
|
* meson.build: Specify 'check' option in run_command()Kjell Ahlstedt2022-02-141-2/+2
| | | | | | The default value will be changed in future Meson releases. Don't use deprecated python3.path() and execute(..., gui_app: ...).
* Add dependencies to Doxygen tag files in subprojectsKjell Ahlstedt2021-05-181-1/+12
| | | | | Doxygen in a main project shall not be called before tag files have been created or updated in subprojects.
* Fix build as subproject without building documentationKjell Ahlstedt2021-05-151-16/+18
| | | | | | | | | * meson.build: If mm-common-get is not found in maintainer-mode with 'required: false', try with 'required: true'. Don't try to use tag_file, if documentation is not built. * docs/reference/meson.build: Don't use variables from modules that don't define doxytagfile. These are subprojects that don't build their documentation.
* Subprojects can use meson.add_dist_script() if meson.version() >= 0.58.0Kjell Ahlstedt2021-05-051-3/+2
| | | | | | | | | | | * meson.build: * docs/reference/meson.build: * gio/giomm/meson.build: * glib/glibmm/meson.build: Call add_dist_script() in a subproject, if meson.version() >= 0.58.0. * tools/build_scripts/handle-built-files.py: Use MESON_PROJECT_DIST_ROOT if it exists, else MESON_DIST_ROOT. It exists if meson.version() >= 0.58.0.
* Meson build: Make it possible to use glibmm as a subprojectKjell Ahlstedt2021-03-121-4/+4
| | | | glib and sigc++ can be subprojects of glibmm.
* docs/reference/Doxyfile.in: Remove obsolete entriesKjell Ahlstedt2021-02-241-2/+1
|
* Change the ABI to glibmm-2.68Kjell Ahlstedt2020-12-111-3/+3
| | | | | | | So we can use the 2.66 version numbers for stable releases in the glibmm-2.4 ABI series. We've done similar ABI name changes several times before.
* Meson build: Add missing Glib::Value and Variant documentationKjell Ahlstedt2020-09-131-1/+5
| | | | | The value_basictypes.h and variant_basictypes.h files, which are generated from .m4 files, were not included in the input to Doxygen.
* docs/reference/: Update for Doxygen >= 1.8.16Kjell Ahlstedt2020-06-292-9/+8
| | | | | | | | | * docs/reference/meson.build: Doxygen 1.8.16 and later does not store tag file names in the html files. This requires changes in meson.build and in doc-install.pl (in mm-common). Otherwise references to other modules won't be updated in the html files when they are installed. * docs/reference/Doxyfile.in: Remove PERL_PATH and MSCGEN_PATH. Doxygen since version 1.8.0 does not use them.
* Change the ABI to glibmm-2.66Kjell Ahlstedt2020-03-171-3/+3
| | | | | | | | | So we can use the 2.64 version numbers for stable releases in the glibmm-2.4 ABI series. We don't need to release a stable ABI-parallel glibmm until we need to release gtkmm 4.0, and that won't happen until GTK 4.0.0 happens. We've done similar ABI name changes several times before.
* Add support for building glibmm with MesonKjell Ahlstedt2020-03-011-0/+170
| | | | | | glibmm can be built with either Autotools or Meson. See MR !27
* Change the ABI to glibmm-2.64Kjell Ahlstedt2019-09-181-3/+3
| | | | | | | | | So we can use the 2.62 version numbers for stable releases in the glibmm-2.4 ABI series. We don't need to release a stable ABI-parallel glibmm until we need to release gtkmm 4.0, and that won't happen until GTK 4.0.0 happens. We've done similar ABI name changes several times before.
* Doxyfile.in: Remove unused configuration constantsKjell Ahlstedt2019-03-211-5/+1
| | | | | Should have been done when they were removed from other files in the fix of issue #22.
* Change the ABI to glibmm-2.62Kjell Ahlstedt2019-03-171-3/+3
| | | | | | | | | So we can use the 2.60 version numbers for stable releases in the glibmm-2.4 ABI series. We don't need to release a stable ABI-parallel glibmm until we need to release gtkmm 4.0, and that won't happen until GTK 4.0.0 happens. We've done similar ABI name changes several times before.
* Change the ABI to glibmm-2.60Kjell Ahlstedt2018-10-311-3/+3
| | | | | | | | | | So we can use the 2.58 version numbers for stable releases in the glibmm-2.4 ABI series. We don't need to release a stable ABI-parallel glibmm until we need to release gtkmm 4.0, and that won't happen until GTK+ 4.0.0 happens, and we don't know when that might be. We've done similar ABI name changes several times before.
* Fix reference documentation generationChun-wei Fan2018-09-101-3/+3
| | | | | | | | | * docs/Makefile.am: Include the filelist.gmake.am files if applicable * glib/glibmm/filelist.gmake.am: * gio/src/filelist.gmake.am: * gio/giomm/filelist.gmake.am: Include filelist.am relative from $(top_srcdir) as we are including the filelist.gmake.am's from docs/ as well.
* Change the ABI to glibmm-2.58Kjell Ahlstedt2018-03-261-3/+3
| | | | | | | | | | | So we can use the 2.55/56 version numbers for more stable releases. We don't need to release a stable ABI-parallel glibmm until we need to release gtkmm 4.0, and that won't happen until GTK+ 4.0.0 happens, and we don't know when that might be. We did this twice before: https://git.gnome.org/browse/glibmm/commit/?id=dee483b29bdaaabc587f3f8b6bff05663e7dccdc https://git.gnome.org/browse/glibmm/commit/?id=9f89221b024b028286bea35f7a4d9b873bfb3266
* Change the ABI to glibmm-2.54Murray Cumming2017-08-251-3/+3
| | | | | | | | | | So we can use the 2.53/54 version numbers for more stable releases. We don't need to release a stable ABI-parallel glibmm until we need to release gtkmm 4.0, and that won't happen until GTK+ 4.0.0 happens, and we don't know when that might be. We did this once before: https://git.gnome.org/browse/glibmm/commit/?id=dee483b29bdaaabc587f3f8b6bff05663e7dccdc
* Change the ABI to glibmm-2.54Murray Cumming2017-03-221-3/+3
| | | | | | | So we can use the 2.51/52 version numbers for more stable releases. We don't need to release a stable ABI-parallel glibmm until we need to release gtkmm 4.0, and that won't happen until GTK+ 4.0.0 happens, and we don't know when that might be.
* Change the ABI to glibmm-2.52.Murray Cumming2016-11-111-3/+3
| | | | | | | | This installs in parallel with glibmm-2.4. There is now corresponding ABI-breaking glib version, but there is for gtk+ (and therefore gtkmm), so this seems like a good time to do this for glibmm too.
* docs: Make Doxygen silentSebastian Geiger2016-07-171-1/+1
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=768797
* docs: Exclude bogus documentation symbolsDaniel Elstner2015-08-261-0/+2
| | | | | * docs/reference/Doxyfile.in (EXCLUDE_SYMBOLS): Add bogus symbols which appeared in the generated documentation but shouldn't.
* docs: Update configuration for Doxygen 1.8.9.1Daniel Elstner2015-08-261-16/+36
| | | | * docs/reference/Doxyfile.in: Regenerate with Doxygen 1.8.9.1.
* docs: Include unused headers in reference documentationDaniel Elstner2015-08-261-3/+3
| | | | | | | | | | | * glib/glibmm/filelist.am (glibmm_files_all_h): New variable that holds all header files, even those which are not included in the build. * gio/giomm/filelist.am (giomm_files_all_h): ditto. * docs/Makefile.am (doc_input): Make Doxygen parse all public header files, including those which are unused in the current build configuration. This ensures that the documentation covers all platforms.
* docs: Define G_OS_UNIX and G_OS_WIN32 unconditionallyDaniel Elstner2015-08-261-9/+3
| | | | | | * docs/reference/Doxyfile.in (PREDEFINED): Always define both G_OS_UNIX and G_OS_WIN32, so that the generated documentation covers all platforms.
* Docs: Use doxygen-extra.cssKjell Ahlstedt2014-11-141-2/+2
| | | | | | * configure.ac: Require mm-common 0.9.7. * .gitignore: Ignore doxygen-extra.css. * docs/reference/Doxyfile.in: Use doxygen-extra.css instead of doxygen.css.
* Predefine G_OS_UNIX or G_OS_WIN32 in Doxygen's configuration file.Kjell Ahlstedt2013-01-301-6/+54
| | | | | | | * docs/reference/Doxyfile.in: Predefine either G_OS_UNIX or G_OS_WIN32, depending on HOST_WINDOWS_NATIVE. Update to Doxygen 1.8.3 status. * glib/src/iochannel.hg: Remove the DOXYGEN_SHOULD_SKIP_THIS that was added just to get Windows-specific methods included in the documentation.
* Use the latest mm-common.Murray Cumming2011-03-301-7/+0
| | | | | | * configure.ac: Require the latest version. * doc/Makefile.am: Don't specify the mm-common .pl files to distribute because mm-common now does this automatically.
* Avoid a tarball dependency on mm-common.Murray Cumming2011-03-241-1/+8
| | | | | | | * configure.ac: Add a call to MM_CONFIG_DOCTOOL_DIR() telling it to copy the files locally and use them from there. * docs/Makefile.am: Dist the copied files, so that the build does not try to use the versions installed by mm-common.
* Do not install the doctool/*.pl scripts, such as doc-install.pl.Murray Cumming2011-03-151-3/+0
| | | | | | | * docs/Makefile.am: These were already installed by mm-common too, and are now discovered via pkg-config from mm-common-util, by the existing macro. No changes should be necessary to other modules, though autogen.sh might need to be run again.
* Add main page to Doxygen documentationDavid King2010-04-161-1/+2
| | | | | * docs/Makefile.am: Parse glib/glibmm.h for documentation. * glib/glibmm.h: Add main page to Doxygen documentation.
* Fine-tune Doxygen configuration to improve outputDaniel Elstner2010-01-061-8/+9
| | | | | | | | | | | | | | | | * docs/reference/Doxyfile.in (SHOW_INCLUDE_FILES): Enable option, as it looks better than SHOW_USED_FILES and can be adjusted by means of the @headerfile command. (SHOW_USED_FILES): Disable. (ALPHABETICAL_INDEX): Enable alphabetical class index. (PREDEFINED): Predefine G_GNUC_INTERNAL in anticipation of explicit symbol visibility attributes. (CLASS_DIAGRAMS): Enable to get class inheritance graphs without any of the other graph options. (DOT_FONTNAME): Change to Sans to avoid the bad hinting for FreeSans at least on my system, which resulted in blurry graph labels. (COLLABORATION_GRAPH), (GROUP_GRAPHS), (TEMPLATE_RELATIONS): Disable additional graphs to reduce the noise.
* Remove sigc from the Doxygen excluded symbolsDaniel Elstner2009-09-021-1/+0
| | | | | | | | * docs/reference/Doxyfile.in (EXCLUDE_SYMBOLS): Stop excluding the sigc namespace from the documentation since it apparently also removes the links to external documentation. Also, with the latest changes in libsigc++ it seems no longer necessary to suppress the symbol.
* Update Doxygen configuration for Doxygen 1.6.1Daniel Elstner2009-09-011-5/+5
| | | | | | * docs/reference/Doxyfile.in: Update configuration template using Doxygen 1.6.1. (SORT_MEMBERS_CTORS_1ST): Enable.
* Use shared mm-common Doxygen style sheetDaniel Elstner2009-08-282-2/+2
| | | | | | | * configure.ac (MM_PREREQ): Require mm-common 0.7. * docs/Makefile.am (dist_doctool_DATA): List doxygen.css. * docs/reference/Doxyfile.in (HTML_STYLESHEET): Assign path to the shared doxygen.css provided by mm-common.
* Remove header and footer HTML fragmentsDaniel Elstner2009-08-284-35/+5
| | | | | | | | | | | | | | | * docs/reference/glibmm_{header,footer}.html_fragment: Delete files. These custom fragments were an unnecessary maintenance hassle. Also, the files were out of date with respect to the encoding and CSS classes used by Doxygen. * docs/reference/Doxyfile.in (HTML_HEADER), (HTML_FOOTER): Set to the empty string. (PROJECT_NUMBER): Substitute @PACKAGE_VERSION@. It does look nicer in the generated HTML pages, and is probably also less confusing. (SORT_GROUP_NAMES): Enable for predictability. * docs/Makefile.am (dist_noinst_DATA): Remove deleted HTML fragment files.
* Reenable hierarchy graphs for each classDaniel Elstner2009-08-261-1/+1
| | | | | * docs/reference/Doxyfile.in (COLLABORATION_GRAPH): Set option to YES to enable the per-class inheritance graphs.
* Change documentation host to library.gnome.orgDaniel Elstner2009-08-252-6/+2
| | | | | | | | | | * docs/Makefile.am (htmlrefpub): Remove override and use the updated mm-common default value. * docs/reference/glibmm_header.html_fragment: Adjust links to the main page and the gtkmm book. * {glib,gio}/{glib,gio}mm{,-uninstalled}.pc.in (htmlrefpub): Adjust variable values. * configure.ac (MM_PREREQ): Require mm-common 0.6.1.
* Rename @since back to @newinDaniel Elstner2009-08-201-1/+1
| | | | | | | | | | | | * docs/reference/Doxyfile.in (ALIASES): Rename the @since alias back to its old name @newin, but otherwise keep the parameters. Apparently there is a @since command predefined in Doxygen which I hadn't noticed. It does seem to get overridden silently, but it is better not to rely on this. * tools/pm/DocsParser.pm (convert_tags_to_doxygen): Output @newin instead of @since. * {glib,gio}/src/*.hg, {glib,gio}/{glib,gio}mm/*.h: Replace all uses of @since with @newin.
* Predefine GIOMM_API for DoxygenDaniel Elstner2009-08-201-0/+1
| | | | | * docs/reference/Doxyfile.in (PREDEFINED): Define GIOMM_API to the empty expansion, so that it won't show up in the documentation.
* Predefine GLIBMM_API for DoxygenDaniel Elstner2009-08-191-0/+1
| | | | | * docs/reference/Doxyfile.in (PREDEFINED): Define GLIBMM_API to the empty expansion, so that it won't show up in the documentation.
* Implement parametric Doxygen alias @since{m,n}Daniel Elstner2009-08-181-15/+5
| | | | | | | | | | | | * docs/reference/Doxyfile.in (ALIASES): Define a parametrized alias @since{major,minor} to replace the old @newin?p?* aliases which had to be defined manually for every version number used. (PREDEFINED): Predefine G_GNUC_NORETURN, G_GNUC_NULL_TERMINATED and G_GNUC_PURE to the empty expansion. Remove GTKMM_* macros. * tools/pm/DocsParser.pm (convert_tags_to_doxygen): Change "Since:" substitution to output the new generic @since alias. * {glib,gio}/src/*.hg, {glib,gio}/{glib,gio}mm/*.h: Change all uses of @newin?p?* to @since{major,minor}.
* Append slash to overridden $(htmlrefpub)Daniel Elstner2009-08-171-1/+1
| | | | | * docs/Makefile.am (htmlrefpub): Append trailing slash for consistency with the non-overridden value.
* Exclude non-glibmm symbols from the documentationDaniel Elstner2009-08-171-0/+3
| | | | | * docs/reference/Doxyfile.in (EXCLUDE_SYMBOLS): Add GTimeVal, nil and sigc to the list of symbols to exclude from the documentation.
* Reenable JAVADOC_AUTOBRIEF mode of DoxygenDaniel Elstner2009-08-171-1/+1
| | | | | | * docs/reference/Doxyfile.in (JAVADOC_AUTOBRIEF): Change value back to 'YES'. I accidentally turned off the setting during the build infrastructure transition.
* Micro pedantry: sort file list alphabeticallyDaniel Elstner2009-08-111-1/+1
|
* Add missing datadir substitution to .pc fileDaniel Elstner2009-08-111-5/+0
| | | | | | | | | * glib/glibmm-2.4.pc.in (datadir): Substitute value, as it is used as a component of doctooldir later in the file. * gio/giomm-2.4.pc.in (datadir): Substitute value, just in case. * docs/Makefile.am: Remove overrides of the documentation utilities, since MM_CONFIG_DOCTOOL_DIR() already takes care of setting MMDOCTOOLDIR to the local directory.