| 1 | <?PHP
|
|---|
| 2 |
|
|---|
| 3 | /* RDFInt.php - RDF Interfaces for PHP
|
|---|
| 4 | * Copyright 2011 netlabs.org
|
|---|
| 5 | * Author: Christian Langanke, Adrian Gschwend
|
|---|
| 6 | *
|
|---|
| 7 | * Licensed under the Apache License, Version 2.0 (the "License");
|
|---|
| 8 | * you may not use this file except in compliance with the License.
|
|---|
| 9 | * You may obtain a copy of the License at
|
|---|
| 10 | *
|
|---|
| 11 | * http://www.apache.org/licenses/LICENSE-2.0
|
|---|
| 12 | *
|
|---|
| 13 | * Unless required by applicable law or agreed to in writing, software
|
|---|
| 14 | * distributed under the License is distributed on an "AS IS" BASIS,
|
|---|
| 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|---|
| 16 | * See the License for the specific language governing permissions and
|
|---|
| 17 | * limitations under the License.
|
|---|
| 18 | */
|
|---|
| 19 |
|
|---|
| 20 | /**
|
|---|
| 21 | * @page page_option_doxygen Option: Generating the RDFint.PHP online help
|
|---|
| 22 | *
|
|---|
| 23 | * \section sec_doxygen_prerequisites Prerequisites
|
|---|
| 24 | *
|
|---|
| 25 | * For building the online help, Doxygen is required.
|
|---|
| 26 | * Install for you platform as described at:
|
|---|
| 27 | * \htmllinkext{http://www.stack.nl/~dimitri/doxygen/download.html}
|
|---|
| 28 | *
|
|---|
| 29 | * \note For generating the online help, \c GNU \c make is being used.
|
|---|
| 30 | * Under Windows operating systems,
|
|---|
| 31 | * \htmllinkext{http://ftp.gnu.org/gnu/make/,GNU make} needs to be installed on your system.
|
|---|
| 32 | * Just place \c make.exe into a diectory specified in your \c PATH environment variable.
|
|---|
| 33 | *
|
|---|
| 34 | * \section sec_doxygen_generate Generating the online help
|
|---|
| 35 | *
|
|---|
| 36 | * For compiling the online help, execute \c make in the directory \c unittest.
|
|---|
| 37 | *
|
|---|
| 38 | * The available make targets can be shown by executing \c make with no target:
|
|---|
| 39 | \verbatim
|
|---|
| 40 | makefile for documentation of RDFInt.PHP
|
|---|
| 41 |
|
|---|
| 42 | Valid targets:
|
|---|
| 43 |
|
|---|
| 44 | help - display this help
|
|---|
| 45 | all - generate help and load into browser
|
|---|
| 46 | ship - generate help and ship to developers.netlabs.org
|
|---|
| 47 | showcfg - display the doxygen configuration
|
|---|
| 48 | clean - remove config file and generated docs
|
|---|
| 49 | again - rebuild everything
|
|---|
| 50 | \endverbatim
|
|---|
| 51 | *
|
|---|
| 52 | * \note The target \c ship will work only for the maintainers of the project.
|
|---|
| 53 | *
|
|---|
| 54 | */
|
|---|
| 55 |
|
|---|
| 56 |
|
|---|
| 57 | ?>
|
|---|
