Hi. On ffmpeg-devel, I have started a discussion about embedding the documentation into the libraries and having an API to retrieve it in various formats and levels of details.
https://lists.ffmpeg.org/lore/ffmpeg-devel/[email protected]/T/ I summarized my ideas like that: # To make things clear, this is the kind of code I would like to make # possible (omitting error checks): # # char *doc = av_doc_get_as_string(button->ctx, AV_DOC_SHORT | AV_DOC_PLAINTEXT); # gtk_widget_set_tooltip(button->widget, doc); # # (in case it is not self-explanatory: ask lav* for a short string in # plain text that document a context associated to a GUI button and set it # as the tooltip for the button) # # or: # # create_temp_file(&tmpfile); # av_doc_get_to_file(ctx, tmpfile, AV_DOC_LONG | AV_DOC_HTML_DOC); # spawn_web_browser(url_for(tmpfile)); # # (in case it is not self-explanatory: prepare a temporary file, ask lav* # to write into it a long documentation in HTML for a component and open a # web browser to display it) And the first question asked is: Do we want it? Since here is the mailing-list where people discuss how to use the API, I am assuming there are people who develop applications using libav* and therefore might find it useful: your opinion on the subject is important too: do you want it? And later, conditionally: how do you want it? Please contribute to the discussion. Regards, -- Nicolas George _______________________________________________ Libav-user mailing list -- [email protected] To unsubscribe send an email to [email protected]
