QtXmlPatterns -- an implementation of XML technologies

4.5.0-2

Overview

This is the internal developer documentation for QtXmlPatterns. Please refer to Qt Assistant for usage documentation.

The documentation that you are reading right now, can be generated by running doxygen in this directory without arguments. The generated documentation can subsequently be browsed from internal-docs/html/index.html.

Doxygen Conventions

Doxygen conventions, are as follows.

@returns and @param paragraphs are terminated with a period.
When XPath or XQuery expressions/queries appears in the Doxygen comments, wrap them in the tt HTML tag.
Classes and free standing functions should have an @author tag, specifying who is the main author of it.
No code examples should appear directly in the Doxygen comments, they should be included with @include or @dontinclude.
The following terms are marked with @c or the tt HTML tag:
- NaN
- true and false, when referred to as boolean values
- All QNames and item types. For example, item\() and xs:string. Remember to use the tt HTML tag in these cases in order to include non-trivial characters such as paranteses
- null
- stderr, stdout, and stdin

The current Doxygen comments does in some cases not adhere to this, but the idea is to harmonize in that direction over time.

PatternistSDK, located in the test sources, is documented in the PatternistSDK Doxygen module.

Author:: Frans Englich <fenglich@trolltech.com>