← Back to branch summary

~ubuntu-branches/debian/sid/simpleitk/sid

« back to all changes in this revision

Viewing changes to Utilities/GenerateDocs/README

  • Committer: Package Import Robot
  • Author(s): Ghislain Antony Vaillant
  • Date: 2017-11-02 08:49:18 UTC
  • Revision ID: package-import@ubuntu.com-20171102084918-7hs09ih668xq87ej
Tags: upstream-1.0.1
Import upstream version 1.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
Utilities/GenerateDocs/README
 
1
 
 
2
This directory contains scripts used to process and generate documentation for SimpleITK.
 
3
 
 
4
Overview:
 
5
Much of the SimpleITK documentation that is in the form of doxygen strings and
 
6
API language docs is derived from ITK's Doxygen. The process starts
 
7
when Doxygen is run on ITK and it produces the ITK Doxygen in XML
 
8
format. This can either be generated locally or the nightly can be
 
9
automatically downloaded. Next the JSONDocUpdate.sh script can be run
 
10
to extract the strings from the ITK XML Doxygen and update the
 
11
SimpleITK JSON filter descriptions. When SimpleITK is built the JSON
 
12
is used as source for the C++ code. Then when SimpleITK's Documentation
 
13
target is made, the SimpleITK Doxygen in XML will be generated. Lastly
 
14
the SwigDocUpdate.sh script can be run to convert the SimpleITK
 
15
Doxygen XML into Swig .i files so that when SimpleITK is built, inline
 
16
documenation for some wrapped languages will be available.
 
17
 
 
18
Important end use scripts (see script files for more details:
 
19
        JSONDocUpdate.sh - Copies ITK Doxygen into SimpleITK JSON
 
20
        SwigDocUpdate.sh - Copies SimpleITK Doxygen into Swig .i files
 
21
 
 
22
Configuration:
 
23
        The config_vars.sh file needs to be manually modified for the system and build configuration.
 
24
 
 
25
These scripts are manually run to modify and create files in the source tree with the derived documentation.