PHP Classes
elePHPant
Icontem

File: makedoc.sh

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of Richard Munroe  >  cURL  >  makedoc.sh  >  Download  
File: makedoc.sh
Role: Auxiliary script
Content type: text/plain
Description: Generate the documentation using phpdoc
Class: cURL
cURL extension wrapper access remote Web resources
Author: By
Last change:
Date: 10 years ago
Size: 2,193 bytes
 

Contents

Class file image Download
#!/bin/bash
# $Id: makedoc.sh,v 1.1.1.1 2004/12/01 14:47:40 munroe 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="cURL class Documentation"

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

#/**
# * name of a directory(s) to parse directory1,directory2
# * $PWD is the directory where makedoc.sh
# *
# * @var string PATH_PROJECT
# */
PATH_PROJECT=$PWD

#/**
# * path of PHPDoc executable
# *
# * @var string PATH_PHPDOC
# */
PATH_PHPDOC=phpdoc

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

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

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

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

#/**
# * parse elements marked as private
# *
# * @var bool (on/off) PRIVATE
# */
PRIVATE=on

# make documentation
$PATH_PHPDOC -d $PATH_PROJECT -t $PATH_DOCS -ti "$TITLE" -dn $PACKAGES \
-o $OUTPUTFORMAT:$CONVERTER:$TEMPLATE -pp $PRIVATE


# vim: set expandtab :