Changeset 41

Timestamp:

Jul 15, 2011, 5:09:00 PM (14 years ago)

Author:

cla

Message:

rdfint

• reworked documentation, moved options to related subpages

Location:

php/trunk/doxygen

Files:

• doc_page_appedix_arc2patch.php (moved) (moved from php/trunk/doxygen/doc_page_arc2patch.php ) (1 diff)
• doc_page_appendix_license.php (moved) (moved from php/trunk/doxygen/doc_page_license.php ) (1 diff)
• doc_page_main.php (modified) (3 diffs)
• doc_page_option_doxygen.php (added)
• doc_page_option_fdebug.php (added)
• doc_page_option_unittest.php (added)
• doc_page_specs.php (modified) (1 diff)

php/trunk/doxygen/doc_page_appedix_arc2patch.php

@@ -19 +19 @@
 
 /**
- * @page page_arc2_patch Patch for ARC2 for usage under Windows operating systems
+ * @page page_appendix_arc2_patch Appendix: Patch for ARC2 for usage under Windows operating systems
  *
  * For usage under Windows operating systems, the method

php/trunk/doxygen/doc_page_appendix_license.php

@@ -19 +19 @@
 
 /**
- * @page page_license Apache License Version 2.0
+ * @page page_appendix_license Appendix: Apache License Version 2.0
  *
  *\section sec_header License for \libname_lit

php/trunk/doxygen/doc_page_main.php

@@ -56 +56 @@
  *
  * \note For usage under Windows operating systems,
- * \htmllink{page_arc2_patch.html, a patch is required} to be able to read files from
+ * \htmllink{page_appendix_arc2_patch.html, a patch is required} to be able to read files from
  * the local filesystem.
  *
  * \section sec_main_options Options
  *
- * For debugging purposes, the classes of \libname can provide debug event messages.
- * To catch these messages, the debug message logger \c fDebug is required. \n
- * Download from  \htmllinkext{http://fdebug.de/en/site/download/}
+ * See the following sections for further options with using \libname:
  *
- * See the provided samples of \libname for sample code, if you intend
- * to use \c fDebug for your code as well.
+ * - \htmllink{page_option_fdebug.html,Using fDebug to log debug event messages}
+ * - \htmllink{page_option_unittest.html,Executing RDFint.PHP unittests}
+ * - \htmllink{page_option_doxygen.html,Generating the RDFint.PHP online help}
  *
  * \section sec_main_config Configuration
@@ -78 +77 @@
  * \enddesctable
  *
- * If \c fDebug is to be used, the following environment variable must be defined:
- * \desctable
- * \desc{<strong>Environment&nbsp;variable</strong>,<strong>Value</strong>}
- * \desc{\c PHP_LIBROOT_FDEBUG,Root directory of \c fDebug - contains subdirectories \c client and \c server. 
- *                   As an alternative the directory containing the file \c fdebug.lib.php can be specified.}
- * \enddesctable
- *
  * \note Also under Windows operating systems, pathnames \c MAY \c NOT contain backslashes!
  *       Instead slashes \c MUST be used.
@@ -90 +82 @@
  * \section sec_main_license License
  *
- * \libname is distributed under the \htmllink{page_license.html,Apache License Version 2.0}
+ * \libname is distributed under the \htmllink{page_appendix_license.html,Apache License Version 2.0}
  *
  */

php/trunk/doxygen/doc_page_specs.php

@@ -19 +19 @@
 
 /**
- * @page page_w3cspecs W3C Specifications Overview and Library Compatibility
+ * @page page_appendix_w3cspecs Appendix: W3C Specifications Overview and Library Compatibility
  *
  *\section sec_w3cspecs_overview W3C Specifications