gimp/devel-docs
Jehan 70a9576f27 app, devel-docs, libgimpbase: s/gimp_parasite_name/gimp_parasite_get_name/…
… and s/gimp_parasite_flags/gimp_parasite_get_flags/

It is better to have a consistent API and the fact is that most
getter/setter functions use the _get|set_ naming, but these didn't.

I wondered if this was such a great idea to rename these anyway because
even though we are breaking API in GIMP 3, is it the best idea to rename
when no functional change happened? After discussing with Wormnest, we
still agreed it was still better to go for consistency rather than
regret later (and be stuck with these names for many more years).

Also this fixes these warnings:

> [649/1205] Generating gimp-3.0.vapi with a custom command
> Gimp-3.0.gir:24162.7-24162.56: warning: Field `Gimp.Parasite.flags' conflicts with method of the same name
> Gimp-3.0.gir:24318.7-24318.52: warning: Field `Gimp.Parasite.name' conflicts with method of the same name
2021-04-05 18:36:44 +02:00
..
app Remove GimpInt16Array 2021-02-18 11:32:45 +00:00
g-ir-docs devel-docs: generate both gjs (Javascript) and Python API docs. 2021-01-29 18:04:20 +01:00
GIMP3-plug-in-porting-guide Fix typos 2020-11-19 21:56:25 +01:00
libgimp Remove GimpInt16Array 2021-02-18 11:32:45 +00:00
libgimpbase app, devel-docs, libgimpbase: s/gimp_parasite_name/gimp_parasite_get_name/… 2021-04-05 18:36:44 +02:00
libgimpcolor devel-docs: REVERT THIS once module.actions get removed automatically 2020-10-25 20:18:52 +01:00
libgimpconfig devel-docs: REVERT THIS once module.actions get removed automatically 2020-10-25 20:18:52 +01:00
libgimpmath devel-docs: REVERT THIS once module.actions get removed automatically 2020-10-25 20:18:52 +01:00
libgimpmodule devel-docs: REVERT THIS once module.actions get removed automatically 2020-10-25 20:18:52 +01:00
libgimpthumb devel-docs: REVERT THIS once module.actions get removed automatically 2020-10-25 20:18:52 +01:00
libgimpwidgets devel-docs: Update libgimpwidgets3-sections.txt 2020-12-29 23:07:07 +01:00
performance-logs devel-docs: document new "Messages" performance-log parameter 2020-08-02 11:02:01 +03:00
tools Meson port. 2019-09-11 16:42:04 +02:00
.gitignore devel-docs, libgimp: update some .gitignore files 2019-11-19 20:40:22 +01:00
c.vim devel-docs: c.vim to help contributors enforce our coding style in VIM. 2016-08-23 17:37:10 +02:00
commit-rules.txt Bug 795557 - Misc. typo fixes in source, comments and doxygen (pt3) 2018-04-25 23:49:06 +02:00
compositing.txt Review, amend and update the XCF file format spec and parasites.txt 2014-10-20 20:52:30 +02:00
contexts.txt devel-docs: minor typo. 2018-03-29 17:26:23 +02:00
debug-plug-ins.txt Issue #6446: Typo fixes. 2021-02-24 12:33:03 +01:00
debugging-tips.txt devel-docs: quick command to get the right flatpak runtime version. 2021-03-28 17:18:52 +02:00
exif-handling.txt Bill Skaggs <weskaggs@primate.ucdavis.edu> 2005-01-04 17:48:13 +00:00
gbr.txt Corrected consistency of name length and wording of the v3 explanation 2009-06-20 12:46:42 +02:00
ggr.txt devel-docs: add "step" blending function to GGR format spec 2018-10-30 11:03:34 -04:00
gih.txt Bug 795161 - Misc. typo fixes in source comments and doxygen 2018-04-18 21:06:57 +02:00
gimp-module-dependencies.svg app: Get rid of config -> display module dependency 2010-02-01 21:56:48 +01:00
GIMP3-API-Changes.txt devel-docs: some updates to GIMP3-API-Changes.txt 2018-04-18 22:50:56 +02:00
gitlab-milestones.txt More bugzilla -> gitlab in various files 2018-07-11 22:24:02 +02:00
gpb.txt Add other misc. typo fixes 2019-08-13 11:50:51 -04:00
gtkbuilder-porting-guide.txt Fix typos 2020-03-17 12:30:45 +00:00
icons.txt devel-docs: howto test high density. 2018-05-26 22:41:54 +02:00
includes.txt Bug 795557 - Misc. typo fixes in source, comments and doxygen (pt3) 2018-04-25 23:49:06 +02:00
Jenkins-Tutorial.odt Add Jenkins tutorial 2014-10-26 13:08:36 +01:00
libtool-instructions.txt devel-docs: Add libtool-instructions.txt 2014-08-27 08:41:02 +05:30
Makefile.am devel-docs: generate Python API (GObject Introspected) documentation. 2021-01-29 15:22:36 +01:00
meson.build devel-docs, meson: g-ir-doc option to generate introspected API docs. 2021-01-29 16:51:47 +01:00
os-support.txt devel-docs: update macOS support to OSX 10.12 on master. 2018-06-27 16:10:49 +02:00
parasites.txt Bug 795161 - Misc. typo fixes in source comments and doxygen 2018-04-18 21:06:57 +02:00
pat.txt Bug 587710 – PAT file specification seems to have a wrong magic number 2009-07-12 19:26:13 +03:00
README Change a bazillion URLs to https:// 2018-07-14 14:19:27 +02:00
README.gtkdoc Use "Returns:" to annotate return values 2019-08-03 07:53:47 +00:00
release-howto.txt devel-docs: some small release-howto updates. 2020-12-23 01:54:10 +01:00
release-stats.sh devel-docs: update the stats script. 2020-01-01 23:27:43 +01:00
structure.xml Bug 795161 - Misc. typo fixes in source comments and doxygen 2018-04-18 21:06:57 +02:00
submitting-patches.txt Change a bazillion URLs to https:// 2018-07-14 14:19:27 +02:00
tagging.txt devel-docs: rewording, grammar fixes, etc. 2013-03-08 21:38:19 +01:00
ui-framework.txt Bug 795161 - Misc. typo fixes in source comments and doxygen 2018-04-18 21:06:57 +02:00
undo.txt Moved various files from the docs directory to devel-docs and 2000-06-13 14:05:35 +00:00
vbr.txt Bug 715018 - Developer documentation on VBRs incorrect 2013-11-22 20:47:16 +01:00
version.in [devel-docs] move version file to deduplicate code 2019-09-09 18:15:13 +00:00
xcf.txt Issue #6435: Off canvas guides. 2021-02-15 22:52:27 +01: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