[Date Prev][Date Next][Thread Prev][Thread Next]
[Date Index]
[Thread Index]
- Subject: Re: SDL documentation
- From: Nicolas Noble <pixel@...>
- Date: Sun, 21 Dec 2003 23:12:04 +0100 (CET)
> Have you looked at the 'sdl_module.cpp' which does the C/Lua interface?
> I've done that and i tend to place documentation within the source
> code (hate to maintain two sets of the same stuff!). Example:
>
> //---
> // [rect_tbl]= SDL_ListModes( format_ref, surf_flags )
> //
> // Returns: - non-empty table, listing the available modes
> // - empty table '{ }', if any mode is okay
> // - 'nil' if no modes are supported
> //
Just as a hint: if you want to build docs from a cpp doc, you should try
"doxygen". Works very well, and you won't have to maintain twice the same
documentation ;-)