Contents 
 Index 
 "Perl Program Reference" 
 < Previous 
 Next > 

dox_chg_not.pl

Go to the documentation of this file.
00001 // This file has been modified on-the-fly with an input filter
00002 // to change it from Perl syntax to C++ strictly for the purposes
00003 // of faking out Doxygen. Modifications include:
00004 
00005 // - changing local() definitions to C++ #define statements.
00006 // - commenting out undef statements.
00007 // - changing $globe'... variable names to $globe_...
00008 // - changing sub statements to look like C++ functions.
00009 // - changing # comments to C++ comments.
00010 // - ...
00011 
00012 // If you see other strangeness in the HTML version of the Perl file,
00013 // it comes from getting it to look more C++ like.
00014 
00015 
00016 // #!/usr/#define/bin/perl
00017 
00018 /////////////////////////////////////////////////////////////////////////////////
00019 /** @file
00020  ** @brief Tool for Doxygen for most C/C++ code files.
00021  ** 
00022  ** This changes Doxgyen commands to a style that is more readable.
00023  ** Forward and backward slashes make my eyes dizzy and aren't in the
00024  ** JavaDoc convention. 
00025  **
00026  ** This file isn't used any more. Back when we started using Doxygen, we
00027  ** did not have a good handle on how to structure comments, how to format
00028  ** commands, etc. This tool fixes a mistaken direction taken in the early
00029  ** efforts.
00030  **
00031  ** @param Input source file.
00032  ** @return Output is file with changes.
00033  **
00034  ** @ingroup tp_tools tp_dox
00035  **
00036  ** @author Glenn C. Maxey
00037  **/
00038 // // $Id: dox_chg_not.pl,v 1.4 2002/01/16 19:49:07 gmaxe Exp $
00039 ////
00040 //// 2002 Created by Voyant Technologies, Inc., Westminster, Colorado, USA.
00041 ////
00042 //// Permission to use, copy, modify, and distribute this software and its 
00043 //// documentation under the terms of the GNU General Public License is hereby 
00044 //// granted. No representations are made about the suitability of this software 
00045 //// for any purpose. It is provided "as is" without express or implied warranty. 
00046 //// See the GNU General Public License (http://www.gnu.org/copyleft/gpl.html) 
00047 //// for more details.
00048 //// 
00049 //// Documents produced by this script are derivative works derived from the 
00050 //// input used in their production; they are not affected by this license.
00051 ////
00052 //// $Log: dox_chg_not.pl,v $
00053 //// Revision 1.4  2002/01/16 19:49:07  gmaxe
00054 //// Removed much of revision history in comments.
00055 ////
00056 //// Revision 1.3  2002/01/03 00:25:06  gmaxe
00057 //// Changed the license agreement.
00058 ////
00059 /////////////////////////////////////////////////////////////////////////////////
00060 
00061 NEW_LINE: while (<>) {
00062 
00063    // ######## Begin replacement of Doxygen commands
00064    if (/\@lim/) {
00065       $_ =~ s/\@lim/\@lim/;
00066    } 
00067 
00068    if (/\\param/) {
00069       $_ =~ s/\\param/\@param/;
00070    } 
00071 
00072    if (/\\brief/) {
00073       $_ =~ s/\\brief/\@brief/;
00074    } 
00075 
00076    if (/\\retval/) {
00077       $_ =~ s/\\retval/\@retval/;
00078    } 
00079 
00080    if (/\\return/) {
00081       $_ =~ s/\\return/\@return/;
00082    } 
00083 
00084    if (/\\ingroup/) {
00085       $_ =~ s/\\ingroup/\@ingroup/;
00086    } 
00087 
00088    if (/\@lim/) {
00089       $_ =~ s/\@lim/\@lim/;
00090    } 
00091 
00092    if (/\\note/) {
00093       $_ =~ s/\\note/\@note/;
00094    } 
00095    // ######## End replacement of Doxygen commands
00096    
00097    //  Default Fall through
00098 //    print $_;
00099 
00100 }  
00101 
00102 
00103 
00104 
00105 
00106 
00107 
00108 


 "Perl Program Reference" 
 < Previous 
 Next > 


Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003

TP Tools v2-00-0a

# tpt-perl-hcr-02