Documenting input and output file formats

--===============8363148874060641808==
Content-Type: multipart/alternative; boundary="000000000000c772a305faa87ce5"

--000000000000c772a305faa87ce5
Content-Type: text/plain; charset="UTF-8"

Has anyone used Doxygen to generate documentation for input and /or output
file formats?

I'm working in the paradigm of a command line program that has a few
plain-text files as input -- and a bunch of other plain-text files as
output.

I'm looking for a means of annotating file read statements (fscanf, fread,
whatever) in the source code. Then,  upon running Doxygen (or another tool)
and providing a pointer to an example file, some form of input file
documentation is generated.

If anyone has used Doxygen for this kind of thing, links to a GitHub repo
showing techniques and best practices would be appreciated.

Thanks for any suggestions.

Rob

--000000000000c772a305faa87ce5
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr">Has anyone used Doxygen to generate documentation for inpu=
t and /or output file formats?<div><br></div><div>I&#39;m working in the pa=
radigm=C2=A0of a command=C2=A0line program that has a few plain-text files =
as input -- and a bunch of other plain-text files as output.</div><div><br>=
</div><div>I&#39;m looking for a means of annotating file read statements (=
fscanf, fread, whatever) in the source code. Then,=C2=A0 upon running=C2=A0=
Doxygen (or another tool) and providing a pointer to an example file, some =
form of input file documentation is generated.</div><div><br></div><div>If =
anyone has used Doxygen for this kind of thing, links to a GitHub repo show=
ing techniques and best practices would be appreciated.</div><div><br></div=
><div>Thanks for any suggestions.</div><div><br></div><div>Rob</div></div>

--000000000000c772a305faa87ce5--


--===============8363148874060641808==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline


--===============8363148874060641808==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users

--===============8363148874060641808==--