AsmDoc 0.0.0.1 alpha
====================


About
-----

This is example of my starting project. It is supposed to be
DoxyGen-like (or JavaDoc-like) documentation generator for assembly
languages.

Currently it is in very early stage, it only supports few syntax
and documentation items, for single input file. This serves
only as proof-of-concept example.

It is modular, and it is meant to support multiple syntaxes and
multiple output formats. XML output format could allow it to
cooperate with DoxyGen and be used in mixed projects.



USAGE for this version: 
-----------------------

Comments for AsmDoc are double semicolons:
	;;

AsmDoc comments can be either in lines immediately before 
described item, or on the right side of item and in following
lines.

	;; Overloaded inherited recursive virtual
	;; undecorated spaghetti leaf function 
	myproc:

	size dd 10	;; Size of something.
			;; Should be in range 0-100

Besides description of item, comments can contain additional
specifiers:

	@name <name>
		Definition of item name. Not needed, can
		be obtained from source.
	@desc
		Description of item. This is default, if no
		specifier is given.
	@ret
		Description of return value of function

	@arg <name> or @param <name>
		Description of parameter. This specifier is
		followed by name and description of parameter

See file example.asm for practical example of commenting.
You can run test.bat, to see what information is obtained
by AsmDoc.