Re: [fltk.coredev] Re: fl_arc() doc improvement? - Forums

On 8/29/26 18:06 Greg Ercolano wrote:

To redo the doxygen docs, perhaps there's an \include technique of some kind so the docs from elsewhere get pulled in to that same location, avoiding duplicate docs.

Yep, there is (for instance) `\include{doc}` which we already use, but IIRC that requires an entire file to be included.

documentation/src/index.dox:11:    <B>FLTK \include{doc} version.dox Programming Manual</B>
documentation/src/index.dox:16:    \include{doc} copyright.dox
documentation/src/preface.dox:6:\include{doc} version.dox,
documentation/src/preface.dox:83:FLTK is \include{doc} copyright.dox

The included files copyright.dox and version.dox are tiny fragments generated by CMake for exactly this usage.
Example:

$ cat documentation/copyright.dox.in
Copyright &copy; 1998 - @YEAR@ by Bill Spitzak and others.

This is to avoid having to edit certain files at every turn of the year.

If we wanted to include some documentation details in more than one place, then we'd have to add one file for each piece of docs (AFAICT). That doesn't make it easier to maintain.

--
You received this message because you are subscribed to the Google Groups "fltk.coredev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to fltkcoredev+unsubscribe@googlegroups.com.
To view this discussion visit https://groups.google.com/d/msgid/fltkcoredev/3ef5f3e2-8434-45c6-b0cb-f86fce5891f2%40aljus.de.
[ Direct Link to Message ]

[ Previous Message ]

[ New Message | Reply ]

[ Next Message ]