From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by master.gitmailbox.com (Postfix) with ESMTP id 6454B46190 for ; Mon, 8 May 2023 19:05:44 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id C978E68BECD; Mon, 8 May 2023 22:05:41 +0300 (EEST) Received: from nef.ens.fr (nef2.ens.fr [129.199.96.40]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 555FB68BA81 for ; Mon, 8 May 2023 22:05:35 +0300 (EEST) X-ENS-nef-client: 129.199.129.80 ( name = phare.normalesup.org ) Received: from phare.normalesup.org (phare.normalesup.org [129.199.129.80]) by nef.ens.fr (8.14.4/1.01.28121999) with ESMTP id 348J5Y2q000679 for ; Mon, 8 May 2023 21:05:34 +0200 Received: by phare.normalesup.org (Postfix, from userid 1001) id 8B918EB5BF; Mon, 8 May 2023 21:05:34 +0200 (CEST) Date: Mon, 8 May 2023 21:05:34 +0200 From: Nicolas George To: FFmpeg development discussions and patches Message-ID: References: <20230507221033.GC4348@mariano> MIME-Version: 1.0 In-Reply-To: <20230507221033.GC4348@mariano> X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.4.3 (nef.ens.fr [129.199.96.32]); Mon, 08 May 2023 21:05:34 +0200 (CEST) Subject: Re: [FFmpeg-devel] Embedded documentation? X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: FFmpeg development discussions and patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: FFmpeg development discussions and patches Content-Type: multipart/mixed; boundary="===============6992240417589449239==" Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Archived-At: List-Archive: List-Post: --===============6992240417589449239== Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="W+tj7QJSHFfdFliZ" Content-Disposition: inline --W+tj7QJSHFfdFliZ Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable 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? >=20 > 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, --=20 Nicolas George --W+tj7QJSHFfdFliZ Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCgAdFiEE6ooRQGBoNzw0KnwPcZVLI8pNxgwFAmRZR/wACgkQcZVLI8pN xgzNPRAApAxljdKq4TdN+X0nUKgIbedSrwe6l8ztsqPDjiG7QDLM4UBwxB89HHw6 VMdvRkT6s1vZBJikMEgywlgRKN3J1KtB/atgAUvvNiG6CCHHi8FQuYxjpT29meFz eUOfHo3vTaOFahNiSHr1qPQAuJsYdWRZ/q9ivtLl+LnXMLU7jcGzTvXn2us9lvha zLUT9VB8dvh9Aty6RgMt3BMetk4BDVjs/JIZnVA19yAWeUpGRsKGd7TgeJ3vIZpq /iD66JnjZVmNIoKpQDJccKwFFa78RN/0CPmJn2DhEarc/jNdKPKDXFfBLY0BECA+ 4Alo4+iK6CkzUOk1xV2YUcN0cXJb7SBcKlZ4aARoDHzO3MV9zdlavBONRXlt2q+E ze2GU6nobtAZIJE5EHJHwdj4BfHan6sPTA472FJG5jYepJGqsvD/LlWZwAfu/kVf 4mS6o9X1lwaHW86X2f56q8YVZY5pqyeft94MWBZ3jq6y20Va7UhjhYrkNZc8kq1H nU6HBex94uk11Clar9xrSGpknJrZn3kfOTltJRty7XTvNWwC2RN/DwboUlhntssI czxCU01/CR5pmLmpg/ZlbZttoge4LiFyg2jLwAlAT+O1k2NF4SMHISm1EzEpgXth 6kseWgCnByUJ5Cx9epKaHMQWVYx/DHSjvQGRtWaUOL6Hnh89zuc= =tdXe -----END PGP SIGNATURE----- --W+tj7QJSHFfdFliZ-- --===============6992240417589449239== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe". --===============6992240417589449239==--