Talk:Style Guidelines: Difference between revisions

Isilkor (talk | contribs)
Responses: Günther
 
Isilkor (talk | contribs)
fwd decls
Line 7: Line 7:
: <!Guenther> Doxygen is only really usefull if you are generating API docs that are intended to be read without looking at the source code
: <!Guenther> Doxygen is only really usefull if you are generating API docs that are intended to be read without looking at the source code
: <!Guenther> That's not a use case for us: our API is C4Script, not some C++ API
: <!Guenther> That's not a use case for us: our API is C4Script, not some C++ API
Afterthoughts [[User:Isilkor|Isilkor]]:
* Use forward declarations instead of including the header inside other headers, if possible.

Revision as of 15:00, 4 August 2009

Responses so far: Günther:

  • local headers before system headers
  • use static instead of anonymous namespaces
  • don't forbid public data members
  • <!Guenther> Demanding Doygen comments is also a very radical change
<!Guenther> Doxygen is only really usefull if you are generating API docs that are intended to be read without looking at the source code
<!Guenther> That's not a use case for us: our API is C4Script, not some C++ API

Afterthoughts Isilkor:

  • Use forward declarations instead of including the header inside other headers, if possible.