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.

Sign up for GitHub

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

Jump to bottom

[UR] Add macro definitions to API Listing documentation #677

Merged
merged 3 commits into from
Jul 4, 2023
Merged

[UR] Add macro definitions to API Listing documentation #677

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
412c658
[UR] Render macros in API Listing
Jul 4, 2023
f6f80b8
[UR] Remove duplicate macro defs
Jul 4, 2023
f4cea52
[UR] Add typedefs to API listings
Jul 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 101 additions & 0 deletions scripts/templates/api_listing.mako
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,54 @@ ${title}
%endif
%endfor # obj in objects

#################################################################
## -------------------------
## Macros
## -------------------------
<%isempty = True%>
<%seen = list() %>
%for obj in objects:
%if re.match(r"macro", obj['type']):
%if obj['name'] in seen:
<% continue %>
%else:
<% seen.append(obj['name'])%>
%endif
%if isempty: # only display section title if there is content.
%if needstitle:
<%needstitle = False%>
${title}
============================================================
%endif
* Macros

<%isempty = False%>
%endif
* :ref:`${th.make_type_name(n, tags, obj).replace("_", "-")}`
%endif
%endfor # obj in objects

#################################################################
## -------------------------
## Typedefs
## -------------------------
<%isempty = True%>
%for obj in objects:
%if re.match(r"typedef", obj['type']):
%if isempty: # only display section title if there is content.
%if needstitle:
<%needstitle = False%>
${title}
============================================================
%endif
* Typedefs

<%isempty = False%>
%endif
* :ref:`${th.make_type_name(n, tags, obj).replace("_", "-")}`
%endif
%endfor # obj in objects

#################################################################
## Generate API documentation
#################################################################
Expand Down Expand Up @@ -159,6 +207,59 @@ ${th.make_type_name(n, tags, obj)}
:project: UnifiedRuntime
%endif

%endif
%endfor # obj in objects

#################################################################
## -------------------------
## Macros
## -------------------------
<%isempty = True%>
<%seen = list() %>
%for obj in objects:
%if not re.match(r"macro", obj['type']):
<% continue %>
%endif # macro
%if obj['name'] in seen:
<% continue %>
%else:
<% seen.append(obj['name']) %>
%endif
%if isempty:
${title} Macros
--------------------------------------------------------------------------------
<%isempty = False%>
%endif # isempty
.. _${th.make_type_name(n, tags, obj).replace("_", "-")}:

${th.make_type_name(n, tags, obj)}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygendefine:: ${th.make_type_name(n, tags, obj)}
:project: UnifiedRuntime
%endfor # obj in objects

#################################################################
## -------------------------
## Typedefs
## -------------------------
<%isempty = True%>
%for obj in objects:
%if re.match(r"typedef", obj['type']):
%if isempty: # only display section title if there is content.
${title} Structures
--------------------------------------------------------------------------------
<%isempty = False%>
%endif
.. _${th.make_type_name(n, tags, obj).replace("_", "-")}:

${th.make_type_name(n, tags, obj)}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygentypedef:: ${th.make_type_name(n, tags, obj)}
:project: UnifiedRuntime


%endif
%endfor # obj in objects

Expand Down