>> Alvin wrote:
>>> In the HTML documentation for Modules -> "File names and URI utility
>>> functions", it appears the #include definition is missing from the
>>> documentation for the functions.
OK, I tweaked the docs around on my local copy of 1.3.x current.
Here's a screenshot example showing the two ways I thought it could go:
http://seriss.com/people/erco/fltk/tmp/filename_include_docs.png
The LEFT shows just a simple '#include' example, which we should
probably do for any global function where the #include is non-obvious.
The RIGHT shows a more complete example with the #include
and an example use of the code.
I figure the "full example" is good for situations where an example
is appropriate, without making the docs too 'busy'. And in cases where
there's no example code, the "include only" example would suffice.
I suppose this is an RFC/suggestion as an FLTK doxygen documentation
standard for global function docs.
_______________________________________________
fltk mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk
