Recent Files
|
|
What's New
|
- Check of the spelling
- C# XML documentation style and tags (limited to summary, remarks, param, returns, see)
- Processing of MS InterDev and MS VS.NET Solution files
- Processing of MS Visual Basic.NET project files
- Processing of MS InterDev projects (local files only)
- Installer for vbdox components using script files
- Started processing of C# project and source files (experimental)
- BUGS, TODO and History lists in PSDK and .NET reports
- All empty lines are converted to new paragraphs
- New
@require tag
- New options
|
More
|
|
|
-
Select the report manager of choice and an appropriate documentation
comment parser from Tools/Options.
-
Select Open from File menu.
Note: It's advisable to copy the project or file for which you want to generate
documentation and open the copy from VBDOX.
-
and choose a file or Visual Basic project or group.
Note: Check the generated documentation files for errors.
Tip:
You can group files in projects and pass them to the program. The format of the file is following:
Module=title1; .\filename1.bas
Module=title2; c:\path\filename2.bas
The comments can contain HTML formatting.
You can make snapshots of your forms and include them and other images in the documentation by using <IMG> tag.
<IMG src="my_form_snapshot.jpeg"/>
Both report managers and documentation comment parsers are extensible. You can write your own which suit better to your needs.
Create your own XSLT for transforming the XML report into a real HTML documentation.
Language filters for the PSDK report manager can be created in the following way:''
' Example of language filters.
' <BR>
' <P><SPAN class=lang>[Visual Basic]</SPAN>
' <CODE>object.foo</CODE>
' </P>
'
' <P><SPAN class=lang>[C++]</SPAN>
' <CODE>HRESULT hr = pobj->foo();</CODE>
' </P>
You can add descriptions to Implements.
he PSDK style report manager generates project, contents and index files for the Microsoft HTML Help Workshop. If you have this program installed, you can compile the HTML files generated from VBDOX.
The fields of the user defined types (UDT or Type) and the values of the enumerators (Enum) are documented as the parameters of the functions.''
' Weekdays
'
' @param Monday Again monday
...
Public Enum WeekDay
Monday
...
Now you can genarate documentation for ASP and VBscript files.
Send bugs, wishes and comments at michael.stamenov@web.de.
Only one level ASP include files are processed.
Check for newest version at VBDOX Home.
Try the example in the folder sample.
You can use MS C# tags for XML documentation.
Next
|