Return values

List of return values used in this script. More...

Variables
const	$C_SUCCESS = 0
	Return value for success.
const	$C_PARSE_ERROR = 1
	Return value on parse error.
const	$C_ANALYSIS_ERROR = 2
	Return value on error when analysing parsed composition.
const	$C_WRITE_ERROR = 3
	Return value on error when writing result.

Detailed Description

List of return values used in this script.

The script works in three stages:

1. Parsing
2. Analysis
3. Writing
   Parsing extracts the meaningful data from the script file.
   Analysis enhances that data.
   Writing outputs the data.

This code is written with readibility as first priority (after the "it should do its job" requirement).

How to use:

1. Add this file to the projects root directory (where your doxyfile lives).
2. Update some of the doxyfile values.
   1. First tell Doxygen to document .sh files as if it is a php file: EXTENSION_MAPPING = sh=php.
   2. Then Doxygen needs to know about this filter: FILTER_PATTERNS = *.sh=./doxygen-bash-filter.sh.
   3. add .sh to the FILE_PATTERNS list.
   4. Optionally add doxygen-bash-filter.sh to the EXCLUDE values. EXCLUDE = doxygen-bash-filter.sh.

      Note

      When EXTENSION_MAPPING, FILTER_PATTERNS or EXCLUDE is already set add the values to the the list.

Variable Documentation

$C_ANALYSIS_ERROR

const $C_ANALYSIS_ERROR = 2

Return value on error when analysing parsed composition.

Definition at line 154 of file doxygen-bash-filter.sh.

$C_PARSE_ERROR

const $C_PARSE_ERROR = 1

Return value on parse error.

Definition at line 152 of file doxygen-bash-filter.sh.

$C_SUCCESS

const $C_SUCCESS = 0

Return value for success.

Definition at line 150 of file doxygen-bash-filter.sh.

$C_WRITE_ERROR

const $C_WRITE_ERROR = 3

Return value on error when writing result.

Definition at line 156 of file doxygen-bash-filter.sh.