Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for xrefitem based page generation #596

Merged
merged 7 commits into from
Nov 15, 2020

Commits on Nov 7, 2020

  1. Update compound parser to better support xrefitem

    When xrefitem, or its specializations, is used some extra XML elements
    are generated which were not properly parsed; this commit adds the extra
    parsing required.
    
    * properly parses a variable list element, which consists of a set of
      varlistentry + listitem elements
    * docTitleTypeSub was extended to to parse the "ref" and "anchor"
      elements which exist inside a varlistentry.
    
    Signed-off-by: Fabio Utzig <[email protected]>
    utzig committed Nov 7, 2020
    Configuration menu
    Copy the full SHA
    14f9581 View commit details
    Browse the repository at this point in the history

Commits on Nov 15, 2020

  1. Add support for Doxygen "page" block and directive

    When xrefitem or any of its specializations is used, Doxygen generates a
    new file of kind="page"; this is very similar to a "group" or
    "namespace" file.
    
    This commit adds proper filter handling and a new directive, doxygenpage,
    that can be used to include documentation from a page block.
    
    Signed-off-by: Fabio Utzig <[email protected]>
    utzig committed Nov 15, 2020
    Configuration menu
    Copy the full SHA
    7fb9366 View commit details
    Browse the repository at this point in the history
  2. Fix link to Doxygen grouping documentation

    Signed-off-by: Fabio Utzig <[email protected]>
    utzig committed Nov 15, 2020
    Configuration menu
    Copy the full SHA
    3f47df5 View commit details
    Browse the repository at this point in the history
  3. Fix message when content element is not found

    When a content block was not found, the message would imply it is of
    type "namespace"; fix it so that the proper "kind" is displayed
    ("namespace", or "group", or "page").
    
    Signed-off-by: Fabio Utzig <[email protected]>
    utzig committed Nov 15, 2020
    Configuration menu
    Copy the full SHA
    f20b539 View commit details
    Browse the repository at this point in the history
  4. Add proper rendering for xrefitem's elements

    The elements "docvariablelist", "docvarlistentry" and "docanchor" are
    used whenever an xrefitem is used in a project, and the proper compound
    of kind="page" is generated.
    
    This commits adds rendering of the elements in a definition block, and
    properly adds a target to anchor elements so they can be referenced
    later.
    
    Signed-off-by: Fabio Utzig <[email protected]>
    utzig committed Nov 15, 2020
    Configuration menu
    Copy the full SHA
    fca9732 View commit details
    Browse the repository at this point in the history
  5. Allow reference from xrefitem title

    Mimic Doxygen html output, by adding a pending_xref to xrefitem titles,
    which can later be resolved to the generated xrefsect page, if it was
    added to the project.
    
    Signed-off-by: Fabio Utzig <[email protected]>
    utzig committed Nov 15, 2020
    Configuration menu
    Copy the full SHA
    ca6243a View commit details
    Browse the repository at this point in the history
  6. Add documentation page for doxygenpage directive

    Add initial documentation with "doxygenpage" usage relying on previously
    added xrefsect examples.
    
    Signed-off-by: Fabio Utzig <[email protected]>
    utzig committed Nov 15, 2020
    Configuration menu
    Copy the full SHA
    6830f3f View commit details
    Browse the repository at this point in the history