[phpwebapp-commits] CVS: documentation/codedoc phpdoc_pdf.sh,NONE,1.1 phpdoc_html.sh,NONE,1.1 generate-code-doc.sh,NONE,1.1 doxygen.cfg,NONE,1.1 README.txt,NONE,1.1

[Dashamir H. <das...@us...>]

Update of /cvsroot/phpwebapp/documentation/codedoc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27022/codedoc

Added Files:
	phpdoc_pdf.sh phpdoc_html.sh generate-code-doc.sh doxygen.cfg 
	README.txt 
Log Message:


--- NEW FILE: phpdoc_pdf.sh ---
#!/bin/bash
# $Id: phpdoc_pdf.sh,v 1.1 2005/11/02 15:23:04 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
##############################

### dasho
### go to this directory
cd $(dirname $0)

#/**
#  * title of generated documentation, default is 'Generated Documentation'
#  * 
#  * @var               string TITLE
#  */
TITLE="phpWebApp"

#/** 
#  * name to use for the default package. If not specified, uses 'default'
#  *
#  * @var               string PACKAGES
#  */
PACKAGES="web_app"

#/** 
#  * 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.3.0rc3/phpdoc

#/**
#  * where documentation will be put
#  *
#  * @var               string PATH_DOCS
#  */
PATH_DOCS=$PWD/download/

#/**
#  * what outputformat to use (html/pdf)
#  *
#  * @var               string OUTPUTFORMAT
#  */
OUTPUTFORMAT=PDF

#/** 
#  * converter to be used
#  *
#  * @var               string CONVERTER
#  */
CONVERTER=default

#/**
#  * template to use
#  *
#  * @var               string TEMPLATE
#  */
TEMPLATE=default

#/**
#  * 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: phpdoc_html.sh ---
#!/bin/bash
# $Id: phpdoc_html.sh,v 1.1 2005/11/02 15:23:04 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
##############################

### dasho
### go to this directory
cd $(dirname $0)

#/**
#  * title of generated documentation, default is 'Generated Documentation'
#  * 
#  * @var               string TITLE
#  */
TITLE="phpWebApp"

#/** 
#  * name to use for the default package. If not specified, uses 'default'
#  *
#  * @var               string PACKAGES
#  */
PACKAGES="web_app"

#/** 
#  * 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.3.0rc3/phpdoc

#/**
#  * where documentation will be put
#  *
#  * @var               string PATH_DOCS
#  */
PATH_DOCS=$PWD/phpwebapp-phpdocu

#/**
#  * 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: generate-code-doc.sh ---
#!/bin/bash

### go to this directory
cd $(dirname $0)

### generate HTML and PDF documentation using phpDocumentor
rm -rf phpwebapp-phpdocu/
./phpdoc_html.sh
./phpdoc_pdf.sh

### create downloadable files
mkdir -p download
tar cfz download/phpwebapp-phpdocu.tar.gz phpwebapp-phpdocu/
cp download/documentation.pdf download/phpwebapp-phpdocu.pdf
gzip download/phpwebapp-phpdocu.pdf
mv download/documentation.pdf download/phpwebapp-phpdocu.pdf

### generate HTML and PDF documentation using doxygen
rm -rf phpwebapp-doxygen
/usr/local/bin/doxygen doxygen.cfg
cd phpwebapp-doxygen/latex/
pdflatex refman
cd ../..

### create downloadable files
tar cfz download/phpwebapp-doxygen.tar.gz phpwebapp-doxygen/html/
cp phpwebapp-doxygen/latex/refman.pdf download/phpwebapp-doxygen.pdf
gzip download/phpwebapp-doxygen.pdf
mv phpwebapp-doxygen/latex/refman.pdf download/phpwebapp-doxygen.pdf

--- NEW FILE: doxygen.cfg ---
# Doxyfile 1.4.5

# 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 (" ")

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
# by quotes) that should identify the project.

[...1198 lines suppressed...]
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
# generate a legend page explaining the meaning of the various boxes and 
# arrows in the dot generated graphs.

GENERATE_LEGEND        = YES

# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
# remove the intermediate dot files that are used to generate 
# the various graphs.

DOT_CLEANUP            = YES

#---------------------------------------------------------------------------
# Configuration::additions related to the search engine   
#---------------------------------------------------------------------------

# The SEARCHENGINE tag specifies whether or not a search engine should be 
# used. If set to NO the values of all tags below this one will be ignored.

SEARCHENGINE           = NO

--- NEW FILE: README.txt ---

This folder contains some files and folders that are used to generate
automatically some code documentation about phpWebApp, using some
external tools.

The files and folders that it contains are:
  generate-code-doc.sh -- re-generates the code documentation for phpWebApp
  doxygen.cfg          -- the configuration for doxygen
  phpdoc_html.sh       -- the configuration for phpDocumentor (HTML output)
  phpdoc_pdf.sh        -- the configuration for phpDocumentor (PDF output)
  phpwebapp-doxygen/   -- the folder where doxygen outputs the documentation
  phpwebapp-phpdocu/   -- the folder where phpDocu outputs the documentation

  download/    -- this folder contains the downloadables of the above 
                  documentatations (.tar.gz)

To generate the doxygen documentation, type: "$ doxygen doxygen.cfg".
'doxygen' usually comes with GNU/Linux distributions, but the latest copy
can be downloaded from www.doxygen.org .

To generate the phpDocumentor documentation, type: "$ ./phpdoc.sh".
It can be downloaded from http://phpdocu.sourceforge.net and it must
be unpacked in the directory phpwebapp (../..).