Contents 
 Index 
 "Perl Program Reference" 
 < Previous 
 Next > 

sapi_check.pl File Reference

Checks the generated SAPI files for completeness. More...

Go to the source code of this file.

Defines

Functions


Detailed Description

Checks the generated SAPI files for completeness.

This uses the "sapi.pm" file that is generated by the "vproto.pl" tool. It can be named something else, but is the $scope_pm input variable to this program.

The "sapi.pm" file was intended for use with the xhelp tool for reducing noise. It has several data structures defined and then // undefined. They were defined because they could have been useful in locating the proper methods and doxygen comments in the code. (It turns out that the ingroup is more effective at that.)

Those data structures were // undefined (with "if (1)" enclosing an "// undef") so that they wouldn't result in unnecessary grep operations.

Those data structures, however, are useful for testing the integrity of the system in terms of missing commands.

This tool expects you to turn off ("if (0)") these // undefinition within the the sapi.pm file. Run this tool and look at the output.

Author:
Glenn C. Maxey

Definition in file sapi_check.pl.


Define Documentation

#define in_file   $_[0]
 

#define in_file   $_[0]
 

Referenced by globe_file_cnt().

#define src_file   $_[0]
 

#define which_test   $_[1]
 


Function Documentation

int BEGIN  
 

Definition at line 76 of file sapi_check.pl.

int END  
 

Definition at line 465 of file sapi_check.pl.

int check_class_dox  
 

Definition at line 348 of file sapi_check.pl.

int check_prototype  
 

Definition at line 308 of file sapi_check.pl.

int using_scheck  
 

Definition at line 432 of file sapi_check.pl.

int write_output_list  
 

Creates a file lists all of the potential errors discovered in the generated files.

Parameters:
file_out  The name of the file to output.

Definition at line 396 of file sapi_check.pl.



 "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