Uploaded image for project: 'MariaDB Server'
  1. MariaDB Server
  2. MDEV-39718

Produce Markdown plugin API documentation

    XMLWordPrintable

Details

    • Task
    • Status: Closed (View Workflow)
    • Major
    • Resolution: Fixed
    • 13.1.2
    • Server
    • None

    Description

      Developers can benefit from a comprehensive plugin API documentation.

      The currently agreed way to produce this is to:

      So all we need is cmake support for the above. This is what this MDEV is about.

      There's a new shell script added to generate the docs (generate_plugin_api_docs.sh). And a cmake target that, when enabled (via the WITH_GENERATED_DOCS) define (off by default) will check the dependencies and call the script to generate the docs as needed.

      Note that the script requires at least moxygen 2.1.11.

      Attachments

        Issue Links

          Activity

            People

              gkodinov Georgi Kodinov
              gkodinov Georgi Kodinov
              Sergei Golubchik Sergei Golubchik
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Git Integration

                  Error rendering 'com.xiplink.jira.git.jira_git_plugin:git-issue-webpanel'. Please contact your Jira administrators.