3 Template documentation



MkHelp can now generate template documentation, that you can complete by hand with your prefered editor. Template doc is very usefull for complete HTML generated files with your own documentation. You can add comments in class, datas member and functions member.

exemple :

suppose the input file foo.i (see foo.i in exemple dir)
=================== foo.i======================================
class foo { int a; public : foo() : a(0) {} foo(int i) : a(i) {} }; ===================== end of file ===========================

after this command (see foo1.bat in exemple dir)
>mkhelp -d -ld c:.\doc\ -lo c:.\html\ foo.i

MkHelp was generated two kind of files, doc files ans html files.
Look at the foo.doc (in doc dir) :

================== foo.doc ============================

//
//File description for class foo
//
//

VERSION{0.1}
AUTHORS{unknow}
COMMENT{
}


[data]

int a{<br>
}


[function]

foo() {<br>
}

foo(int) {<br>
}

================== end of file ============================

As you can see, this file is divided in three sections. The first start from the begining of the file to the [data]. This header section contains three items VERSION, AUTHORS and COMMENT. Each items started with { and terminate by }. (this is a general rule for each kind of items)
[data] Section
In this section you can found all datas from the refered class.
int a{<br> You can put here any ASCII or HTML text. As long as you want.
}

[function] Section
In this section you can found all functions from the refered class.
foo() {<br> You can put here any ASCII or HTML text. As long as you want.
}
As you can see, only param type is need for the function.


When you had filled all these sections, you can recall MkHelp for include you own doc in HTML generated files.
command:(see foo2.bat in exemple dir)

>Mkhelp -ld c:.\doc\ -lo c:.\html\ foo.i

go to the .\html generated files, and see you included doc.

Warning : You normaly generated the doc template file once. Dont forget to run normal html generated file WITHOUT -d option. Otherwise all your doc files will be overwritten !!!!