-
Notifications
You must be signed in to change notification settings - Fork 0
/
Statement of Work-API parser and generator.txt
35 lines (33 loc) · 1.36 KB
/
Statement of Work-API parser and generator.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Busheer
-------
> this lists supported tags by hdoc.py
@author : name of author
@date : date of changes in source
@comment : description of changes in source
@design : brief description of design of module
@bug : open bugs in source
@file : name of file
@description : description of file
@in : in parameters in arguments list
@out : out parameters in arguments list
@param : parameters in arguments list, direction not specified
@returns : return value of function
@function : name of function
@macro : macro define
@enum : enumeration
@struct : structures
@typedef : type defines
@var : global variables
@abbr. : abbreviations
@module : module name
@note : random notes in a file
@project : optional name of project, if not found in any file there
must be only one module define in all headers else print
error
> need to find change log in two revisions of same module based on information
provide with different tags.
the change log will provide information based on
- added comments in file history
- removed a_tags
- added a_tags
- modified a_tags