Files
gimp/devel-docs
Niels De Graef 92e80d12e8 docs: Migrate from gtk-doc to gi-docgen
gtk-doc has been slowly dying for the past few years; with gi-docgen we
have a nice successor.

This also makes sure the C documentation also uses the GIR file, which
in turn means faster build times (since all the C code doesn't have to
be parsed and recompiled again), and has a clear dependency graph.

See the [gi-docgen tutorial] for more info on how the system works.

[gi-docgen tutorial]: https://gnome.pages.gitlab.gnome.org/gi-docgen/tutorial.html
2021-12-27 10:47:34 +01:00
..
2018-03-29 17:26:23 +02:00
2019-08-13 11:50:51 -04:00
2018-05-26 22:41:54 +02:00
2018-07-14 14:19:27 +02:00

Developers documentation 
------------------------

This directory holds information that you will find useful if you
develop a GIMP plug-in or want to work on the GIMP core.

See https://wiki.gimp.org/index.php/Main_Page for more information.

   app                     - setup for documentation of the GIMP core;
                             not built by default since it is huge and
                             only relevant for core developers

   libgimp
   libgimpbase
   libgimpcolor
   libgimpconfig
   libgimpmath
   libgimpmodule
   libgimpthumb
   libgimpwidgets          - complete libgimp documentation generated from
                             the source; see README.gtkdoc

   tools                   - the source code for tools used to generate
                             documentation



   gitlab-milestones.txt   - describes how the GIMP project uses
                             milestones in the GNOME gitlab issue tracker
   commit-rules.txt        - describes rules and things to think
                             about when creating GIMP commits
   contexts.txt            - describes how GimpContexts are used in GIMP
   debug-plug-ins.txt      - how to debug GIMP plug-ins
   exif-handling.txt       - how GIMP should handle EXIF data
   includes.txt            - the policy for inclusion of header files
   parasites.txt           - descriptions of known parasites
   release-howto.txt       - a check-list for doing a GIMP release
   submitting-patches.txt  - how to submit a patch for GIMP
   tagging.txt             - how resource tagging in Gimp works
   ui-framework.txt        - describes how the GIMP UI framework functions and
                             how it is implemented
   undo.txt                - description of the undo system


   structure.xml           - a DocBook article that gives an overview on
                             the directory structure of the GIMP source tree,
                             also check out gimp-module-dependencies.svg


   gbr.txt                 - description of the GBR format used to store
                             pixmap brushes
   ggr.txt                 - description of the GGR format used to store
                             GIMP gradients
   gih.txt                 - description of the GIH format used to store a
                             series of pixmap brushes
   gpb.txt                 - OBSOLETE: description of the GPB format for
                             pixmap brushes
   pat.txt                 - description of the PAT format for patterns
   vbr.txt                 - description of VBR format used for
                             "generated" brushes
   xcf.txt                 - description of Gimp's XCF format