Main Page | Namespace List | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

dox_filter.sh File Reference


Detailed Description

Convince Doxygen to parse files other than source code as part of documentation set.

This script is invoked from with doxygen via bootjvm.dox as the INPUT_FILTER value.

For shell scripts, strip non-comments and convert shell comments beginning in column 1 from (^#) to ( *). These appear to Doxygen to be 'C' style intermediate comments (of stylistic interest).

Convert comment with an explanation point (^#!) character to look like a Doxygen start-of-documentation tag (/*!), a special form of a 'C' style open comment (of syntactic interest).

Convert comment with a slash (^#/) character to look like a Doxygen end-of-documentation tag (*/), a special form of a 'C' style close comment (of syntactic interest).

Other selected files may be converted also, but only the header areas need to begin with a script-style comment. For a simple example, please refer to LICENSE.

Todo:
A Windows .BAT version of this script needs to be written

Control

$URL: https://svn.apache.org/path/name/dox_filter.sh $ $Id: dox_filter.sh 0 09/28/2005 dlydick $

Copyright 2005 The Apache Software Foundation or its licensors, as applicable.

Licensed under the Apache License, Version 2.0 ("the License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and limitations under the License.

Version:
$LastChangedRevision: 0 $
Date:
$LastChangedDate: 09/28/2005 $
Author:
$LastChangedBy: dlydick $ Original code contributed by Daniel Lydick on 09/28/2005.

Reference

Definition in file dox_filter.sh.

Go to the source code of this file.


Generated on Fri Sep 30 18:49:12 2005 by  doxygen 1.4.4