Developer forums (C::B DEVELOPMENT STRICTLY!) > Development

SDK Reference Manual

<< < (2/3) > >>

rickg22:
Wow, it's FANTASTIC! :D This file should be included in the SDK releases!

mandrav:
Very nice work, takeshimiya :D

Yiannis.

takeshimiya:
I'm glad all of you liked it :)


Now, for the improving part:

I've found these bugs:

Current bugs of DoxyS
-----------------------------------------

- Doesn't support text formatting on brief descriptions (not very important).

- The function parameter documentation ///< works well on .h but not on .cpp files.


Current bugs of the C::B comments
-----------------------------------------
- For example on cbplugin.h, at the
virtual void BuildModuleMenu() function, the behaviour of DoxyS is always to take
the brief description from the first line (ie. you don't need @brief or \brief),
but if you are used to, it's better to put the cmd @brief then.

- Also always remember to put /// instead of // to document the code, for
example not like on "compiler.h" at the struct RegExStruct.

- Also try to remember when documenting variables in structs or classes:
int m_iMemberVarShortDoc; ///< Short single line documentation
instead of
int m_iMemberVarShortDoc; // Short single line documentation

- Documenting what is not documented =)


-----------------------------------------
I would like to fix the "C::B comment bugs" but I don't have CVS access (I never used CVS).
Anyways some are easy to fix (most of them are a replace from // to ///),
So Yiannis or rickg22, who do you recommend to fix them?

mandrav:
I will do this. I 'm gradually adding documentation to as-yet-undocumented base SDK classes anyway.

Yiannis.

takeshimiya:
Great :), then the only thing left are the examples and hand-written text.

rickg22 or anyone that knows well how the SDK works, when you find the time, try to make some examples (either in cpp/h very commented or in a plain txt), and some explanation of basic things (like a quick start).

Well, I think that's all to have a helpful sdk manual. =)

Navigation

[0] Message Index

[#] Next page

[*] Previous page