Xalan-C++ API Documentation - Test Build - Review
-------------------------------------------------
Key: XALANC-711
URL: https://issues.apache.org/jira/browse/XALANC-711
Project: XalanC
Issue Type: Task
Components: XalanC
Affects Versions: CurrentCVS
Environment: Unix / Linux - Source Current-SVN for Xalan-C++
Doxygen version 1.7.1
GraphVis (dot) version 2.26.23
Reporter: Steven J. Hathaway
Priority: Minor
Xalan-C++ API Version 1.11 Documentation // TEST BUILD
A successful build of the Xalan-C++ API requires the
JIRA (XALANC-709) patch to be installed.
The attached files for this issue are Work-In-Progress.
The current doxygen configuration file "DoxyXalan1_11.conf"
generates 355 megabytes of html and png graphics.
The resulting API documentation may be more than we wish to
package in the Xalan1_11 documentation release.
I would appreciate your review and comments.
You can post your findings to the [email protected]
mailing list.
====================================================
UPDATE YOUR (LOCAL) COPY OF THE XALAN/C SVN TREE
File: DoxyXalan1_11.conf
Copy to SVN: xalan/c/trunk/xdocs/DoxyXalan1_11.conf
File: header.html
Copy to SVN: xalan/c/trunk/xdocs/html/apiDocs
File: footer.html
Copy to SVN: xalan/c/trunk/xdocs/html/apiDocs
File: asf_logo_wide.gif
Copy to SVN: xalan/c/trunk/xdocs/html/apiDocs
====================================================
I have created the Xalan-C++ API Version 1.11 documentation
using the following programs.
doxygen -- version 1.7.1
graphviz (dot) -- version 2.26.3
====================================================
Create document target directories in your SVN local snapshot.
xalan/c/trunk/build/docs/
====================================================
To generate the Xalan-C++ API Version 1.11
1. Connect to the SVN (xalan/c/trunk/xdocs/) directory
2. Run the doxygen program
% doxygen DoxyXalan1_11.conf 2>errors.txt |tee doxylog.txt
The documentation is generated in "xalan/c/trunk/build/docs/html/"
The target directory can be changed by editing the doxygen
DoxyXalan1_11.conf configuration file.
3. Examine "errors.txt" for fatal errors.
There are currently lots of warnings.
There should be no fatal errors.
====================================================
Documentation Review
Copy the following files into your local SVN (xalan/c/trunk/build/docs/html)
directory to resolve resource references in the footer.html file.
xalan/c/trunk/xdocs/html/apiDocs/asf_logo_wide.gif
xalan/c/trunk/xdocs/html/apiDocs/diagramnotes.html
Examine the resulting documentation with a web browser:
xalan/c/trunk/build/docs/html/index.html
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
