Stefano Sabatini (12023-05-08): > Can you share more details about the plan? In particular, is the doc > going to be embedded in the code itself (e.g. in the C > implementation)? Or should we have some dedicated headers containing > the docs? > > We should also avoid to duplicate the same information between docs > and code, so there should be some way to autogenerate the docs from > the corresponding entries in the code.
This is far from settled, but I imagine something like that: - Short doc paragraphs go directly in the C source code as comments with a specific markup, like doxygen but distinct from it. - Longer doc texts go in a file with the same name as the C source code but a different extension, probably .md. - The build system parses all this to generate source files with the structured documentation to be compiled into the library. - The build system can also parse parts of the C source code to extract the structure information, for example AVOption initializers. - The build system also parses the current texinfo documentation so that we do not have to rewrite it all at once. Regards, -- Nicolas George
signature.asc
Description: PGP signature
_______________________________________________ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
