dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

README README.gtkdoc some updates. 

2003-09-08  Sven Neumann  <sven@gimp.org>

	* README
	* README.gtkdoc
	* structure.xml: some updates.
This commit is contained in:
Sven Neumann 2003-09-08 17:51:44 +00:00 committed by Sven Neumann
parent 28ccbb28f0
commit 61ad245a0d
4 changed files with 44 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
devel-docs/ChangeLog
View File

@ -1,3 +1,9 @@
2003-09-08 Sven Neumann <sven@gimp.org>
* README
* README.gtkdoc
* structure.xml: some updates.
2003-09-08 Sven Neumann <sven@gimp.org>
* app-docs.sgml

10
devel-docs/README
View File

@ -4,6 +4,11 @@ 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.
app - setup for documentation of the GIMP core;
not build by default since it is huge and
only relevant for core developers
includes.txt - the policy for inclusion of header files
libgimp
libgimpbase
libgimpcolor
@ -11,9 +16,14 @@ develop a GIMP plug-in or want to work on the GIMP core.
libgimpmodule
libgimpwidgets - complete libgimp documentation generated from
the source; see README.gtkdoc
structure.xml - a DocBook article that gives an overview on
the directory structure of the GIMP source tree
gih.txt - description of the GIH format used to store a
series of pixmap brushes
gpb.txt - description of the GPB format for pixmap brushes
pat.txt - description of the PAT format for patterns
parasites.txt - descriptions of known parasites
undo.txt - description of the undo system
xcf.txt - description of Gimp's XCF format

27
devel-docs/README.gtkdoc
View File

@ -25,19 +25,28 @@ you will need the following utilities:
Perl v5 - Most of the scripts used are written in Perl.
DocBook DTD v3.0 - This is the DocBook SGML DTD.
http://www.ora.com/davenport
libxslt & libxml2 (version >= 2.3.6) - This is used to convert the
XML templates to HTML.
libxslt & libxml2 (version >= 2.3.6)
This is used to convert the XML templates to HTML.
http://xmlsoft.org/
gtk-doc (version >= 1.0) - This package automatically generates DocBook
documentation from source and is able to convert it into HTML (and
other formats).
DocBook XML DTD v4.1.2
http://www.docbook.org/
gtk-doc (version >= 1.0)
This package automatically generates DocBook documentation from
source and is able to convert it into HTML (and other formats).
ftp://ftp.gtk.org/pub/gtk-doc/
You need to have all this properly setup. This includes the
availability of an XML catalog (/etc/xml/catalog) that tells the
XSLT processor where to look for locally installed DTDs. If that
file is missing, the XSLT processor will try to access the DTDs
online which will either fail or take forever. For this reason,
the docs are not built by default. If you think you have a working
setup, pass '--enable-gtk-doc' to configure.
HOWTO
-----
@ -52,7 +61,7 @@ or removed or parameters changed, there is no need to touch the
Makefile or any other files in the toplevel directory.
In most cases you will work on the documentation by adding or editing
comment blocks in the C source and by editing the template SGML files
comment blocks in the C source and by editing the template XML files
in the tmpl directory.
After you've done any changes to the documentation, running 'make'

31
devel-docs/structure.xml
View File

@ -226,24 +226,6 @@
<informaltable>
<tgroup cols="2" align="left">
<tbody>
<row>
<entry><filename>app/arch</filename></entry>
<entry>
architecture specific code
</entry>
</row>
<row>
<entry><filename>app/arch/i386</filename></entry>
<entry>
Intel 386 specific code
</entry>
</row>
<row>
<entry><filename>app/arch/i386/mmx</filename></entry>
<entry>
MMX code for the Intel 386 processor family
</entry>
</row>
<row>
<entry><filename>app/base</filename></entry>
<entry>
@ -254,7 +236,14 @@
<entry><filename>app/paint-funcs</filename></entry>
<entry>
functions to manipulate pixels, part of the base
functionality, uses code from the arch directory
functionality
</entry>
</row>
<row>
<entry><filename>app/compose</filename></entry>
<entry>
new pixel compositing routines that supersede the code
in <filename>app/paint-funcs</filename>
</entry>
</row>
<row>
@ -262,14 +251,14 @@
<entry>
handling of config files, provides the GimpConfig
interface and the GimpRc object which is used from
all over of the application. Depends on GObject
all over of the application; depends on GObject
</entry>
</row>
<row>
<entry><filename>app/core</filename></entry>
<entry>
the core of the GIMP core, makes heavy use of GObject
but is not GTK+-dependant.
but is not GTK+-dependant
</entry>
</row>
<row>