Commit d281156e authored by Sven Neumann's avatar Sven Neumann Committed by Sven Neumann
Browse files

updated.

2002-12-03  Sven Neumann  <sven@gimp.org>

	* README.gtkdoc: updated.
parent cdeba56b
2002-12-01 Sven Neumann <neo@wintermute>
2002-12-03 Sven Neumann <sven@gimp.org>
* README.gtkdoc: updated.
2002-12-01 Sven Neumann <sven@gimp.org>
* libgimp/Makefile.am (IGNORE_HFILES): ignore gimpmiscui.h.
......
......@@ -18,9 +18,10 @@ information added manually into the SGML files.
Requirements
------------
GIMP releases will contain a complete set of HTML files and the SGML files to
create other formats. You will only need gtk-doc if you want to work on the
documentation itself. In that case you will need the following utilities:
GIMP release tarballs contain a complete set of precompiled HTML files as well
as SGML files to create other formats. You only need gtk-doc if you want to
work on the documentation itself. In that case you will need the following
utilities:
Perl v5 - Most of the scripts used are written in Perl.
......@@ -47,46 +48,22 @@ Carefully read the README that comes with gtk-doc. Then read it again! The
following lines will only give you hints about how our system works. You
should have understood the principles of gtk-doc before you touch it.
The system is already set up so unless there are substantial changes to the
The system is already set up, so unless there are substantial changes to the
source e.g. new files were added, functions were added, renamed or removed or
parameters changed, there is no need to repeat the scan step or rebuild the
templates.
The Makefile will only work if gtk-doc was successfully found when configure
was ran. To rerun the scan step you also need to have GIMP installed (the
version you are documenting) and the correct version of gimptool should be
found in your PATH. If everything was set up correctly running a simple make
should do the trick and generate the SGML and HTML files for you.
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 in the tmpl
directory. The following steps should rebuild the documentation after a
change:
make sgml - Creates the SGML files from the templates found in the tmpl
directory and from the comment blocks found in the source.
make html - Build HTML pages out of the SGML files.
If the source was changed (real changes as described above), you will need to
perform the following two steps before you can rebuild the sgml and html
files:
directory.
make scan - Scans the header files and builds and runs a binary that asks the
objects to describe themselves using the GObject
introspection facilities. That way the hierarchy of widgets,
arguments and signals are determined. If you have added new
objects, you will have to update the MODULE.types files
accordingly before you perform this step.
After you've done any changes to the documentation, running 'make' should
rebuild the documentation. This will however only work if configure was called
with the option '--enable-gtk-doc' and gtk-doc was successfully found. If
everything was set up correctly, running 'make' should do the trick and
generate the SGML and HTML files for you. Since the dependencies are not
perfect, you sometimes need to call 'make clean; make' to force regeneration.
make templates - Merges the changes into the templates. This will output
warnings about any declarations which have been
added/removed. Update the MODULE-sections.txt to include the
new functions etc. in the appropriate sections, and delete
ones which are no longer available. Run "make templates"
again until there are no warnings output.
More information
----------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment