[FFmpeg-devel] [PATCH] doc: add missing hyphen prefix

Tobias Rapp t.rapp at noa-archive.com
Fri Feb 22 16:08:47 EET 2019

On 22.02.2019 14:57, Nicolas George wrote:
> Gyan (12019-02-22):
>>      '-key'  will be easier to search for these users as well. It's also a
>> low-cost arrangement. I trust adept API users will quickly suss out that the
>> hyphen represents CLI. GUI users won't be entering the key string, only the
>> values*, and casual CLI users will immediately recognize which entries
>> pertain to options.
> That would be an argument for using something way more specific than a
> dash.
> Anyway, that kind of marking would belong in the definition of the macro
> @option, not in the body of the documentation.

Yeah, that would be helpful.

Prior art for adding an invisible prefix to HTML markup for exactly this 
use-case: https://duktape.org/api.html


More information about the ffmpeg-devel mailing list