Update of /cvsroot/phpwebapp/documentation/external
In directory sc8-pr-cvs1:/tmp/cvs-serv30664/external
Added Files:
phpdoc.sh doxygen.cfg
Log Message:
config files for code documentation generators: doxygen and phpDocumentation
--- NEW FILE: phpdoc.sh ---
#!/bin/bash
# $Id: phpdoc.sh,v 1.1 2003/08/15 08:09:15 dashohoxha Exp $
#/**
# * makedoc - PHPDocumentor script to save your settings
# *
# * Put this file inside your PHP project homedir, edit its variables and run whenever you wants to
# * re/make your project documentation.
# *
# * The version of this file is the version of PHPDocumentor it is compatible.
# *
# * It simples run phpdoc with the parameters you set in this file.
# * NOTE: Do not add spaces after bash variables.
# *
# * @copyright makedoc.sh is part of PHPDocumentor project {@link http://freshmeat.net/projects/phpdocu/} and its LGPL
# * @author Roberto Berto <darkelder (inside) users (dot) sourceforge (dot) net>
# * @version Release-1.1.0
# */
##############################
# should be edited
##############################
#/**
# * title of generated documentation, default is 'Generated Documentation'
# *
# * @var string TITLE
# */
TITLE="PHP Web Application Framework"
#/**
# * name to use for the default package. If not specified, uses 'default'
# *
# * @var string PACKAGES
# */
PACKAGES="phpWebApp"
#/**
# * name of a directory(s) to parse directory1,directory2
# * $PWD is the directory where makedoc.sh
# *
# * @var string PATH_PROJECT
# */
PATH_PROJECT=$PWD/../../web_app
#/**
# * path of PHPDoc executable
# *
# * @var string PATH_PHPDOC
# */
PATH_PHPDOC=$PWD/phpDocumentor-1.2.1/phpdoc
#/**
# * where documentation will be put
# *
# * @var string PATH_DOCS
# */
PATH_DOCS=$PWD/phpdoc
#/**
# * what outputformat to use (html/pdf)
# *
# * @var string OUTPUTFORMAT
# */
OUTPUTFORMAT=HTML
#/**
# * converter to be used
# *
# * @var string CONVERTER
# */
CONVERTER=frames
#/**
# * template to use
# *
# * @var string TEMPLATE
# */
TEMPLATE=earthli
#/**
# * parse elements marked as private
# *
# * @var bool (on/off) PRIVATE
# */
PRIVATE=off
# make documentation
$PATH_PHPDOC -d $PATH_PROJECT -t $PATH_DOCS -ti "$TITLE" -dn $PACKAGES \
-o $OUTPUTFORMAT:$CONVERTER:$TEMPLATE -pp $PRIVATE
# vim: set expandtab :
--- NEW FILE: doxygen.cfg ---
# Doxyfile 1.3.3
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
# TAG = value [value, ...]
# For lists items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")
#---------------------------------------------------------------------------
# General configuration options
#---------------------------------------------------------------------------
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
[...1070 lines suppressed...]
# documentation, with file:// prepended to it, will be used.
DOC_URL =
# The DOC_ABSPATH tag should be the absolute path to the directory where the
# documentation is located. If left blank the directory on the local machine
# will be used.
DOC_ABSPATH =
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
# is installed.
BIN_ABSPATH = /usr/local/bin/
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
# documentation generated for other projects. This allows doxysearch to search
# the documentation for these projects as well.
EXT_DOC_PATHS =
|
