Changeset 41 for php/trunk/doxygen/doc_page_main.php

Timestamp:

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

Author:

cla

Message:

rdfint

• reworked documentation, moved options to related subpages

File:

• php/trunk/doxygen/doc_page_main.php (modified) (3 diffs)

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}
  *
  */