-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
document common EVT API funcs nicely
- Loading branch information
Showing
13 changed files
with
1,503 additions
and
163 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,262 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <doxygenlayout version="1.0"> | ||
| <!-- Generated by doxygen 1.10.0 --> | ||
| <!-- Navigation index tabs for HTML output --> | ||
| <navindex> | ||
| <tab type="mainpage" visible="yes" title=""/> | ||
| <tab type="pages" visible="yes" title="" intro=""/> | ||
| <tab type="topics" visible="yes" title="" intro=""/> | ||
| <tab type="modules" visible="yes" title="" intro=""> | ||
| <tab type="modulelist" visible="yes" title="" intro=""/> | ||
| <tab type="modulemembers" visible="yes" title="" intro=""/> | ||
| </tab> | ||
| <tab type="namespaces" visible="yes" title=""> | ||
| <tab type="namespacelist" visible="yes" title="" intro=""/> | ||
| <tab type="namespacemembers" visible="yes" title="" intro=""/> | ||
| </tab> | ||
| <tab type="concepts" visible="yes" title=""> | ||
| </tab> | ||
| <tab type="interfaces" visible="yes" title=""> | ||
| <tab type="interfacelist" visible="yes" title="" intro=""/> | ||
| <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/> | ||
| <tab type="interfacehierarchy" visible="yes" title="" intro=""/> | ||
| </tab> | ||
| <tab type="classes" visible="yes" title=""> | ||
| <tab type="classlist" visible="yes" title="" intro=""/> | ||
| <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> | ||
| <tab type="hierarchy" visible="yes" title="" intro=""/> | ||
| <tab type="classmembers" visible="yes" title="" intro=""/> | ||
| </tab> | ||
| <tab type="structs" visible="yes" title=""> | ||
| <tab type="structlist" visible="yes" title="" intro=""/> | ||
| <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/> | ||
| </tab> | ||
| <tab type="exceptions" visible="yes" title=""> | ||
| <tab type="exceptionlist" visible="yes" title="" intro=""/> | ||
| <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/> | ||
| <tab type="exceptionhierarchy" visible="yes" title="" intro=""/> | ||
| </tab> | ||
| <tab type="files" visible="yes" title=""> | ||
| <tab type="filelist" visible="yes" title="" intro=""/> | ||
| <tab type="globals" visible="yes" title="" intro=""/> | ||
| </tab> | ||
| <tab type="examples" visible="yes" title="" intro=""/> | ||
| </navindex> | ||
|
|
||
| <!-- Layout definition for a class page --> | ||
| <class> | ||
| <detaileddescription title=""/> | ||
| <includes visible="$SHOW_HEADERFILE"/> | ||
| <inheritancegraph visible="yes"/> | ||
| <collaborationgraph visible="yes"/> | ||
| <memberdecl> | ||
| <nestedclasses visible="yes" title=""/> | ||
| <publictypes title=""/> | ||
| <services title=""/> | ||
| <interfaces title=""/> | ||
| <publicslots title=""/> | ||
| <signals title=""/> | ||
| <publicmethods title=""/> | ||
| <publicstaticmethods title=""/> | ||
| <publicattributes title=""/> | ||
| <publicstaticattributes title=""/> | ||
| <protectedtypes title=""/> | ||
| <protectedslots title=""/> | ||
| <protectedmethods title=""/> | ||
| <protectedstaticmethods title=""/> | ||
| <protectedattributes title=""/> | ||
| <protectedstaticattributes title=""/> | ||
| <packagetypes title=""/> | ||
| <packagemethods title=""/> | ||
| <packagestaticmethods title=""/> | ||
| <packageattributes title=""/> | ||
| <packagestaticattributes title=""/> | ||
| <properties title=""/> | ||
| <events title=""/> | ||
| <privatetypes title=""/> | ||
| <privateslots title=""/> | ||
| <privatemethods title=""/> | ||
| <privatestaticmethods title=""/> | ||
| <privateattributes title=""/> | ||
| <privatestaticattributes title=""/> | ||
| <friends title=""/> | ||
| <related title="" subtitle=""/> | ||
| <membergroups visible="yes"/> | ||
| </memberdecl> | ||
| <memberdef> | ||
| <inlineclasses title=""/> | ||
| <typedefs title=""/> | ||
| <enums title=""/> | ||
| <services title=""/> | ||
| <interfaces title=""/> | ||
| <constructors title=""/> | ||
| <functions title=""/> | ||
| <related title=""/> | ||
| <variables title=""/> | ||
| <properties title=""/> | ||
| <events title=""/> | ||
| </memberdef> | ||
| <allmemberslink visible="yes"/> | ||
| <usedfiles visible="$SHOW_USED_FILES"/> | ||
| <authorsection visible="yes"/> | ||
| </class> | ||
|
|
||
| <!-- Layout definition for a namespace page --> | ||
| <namespace> | ||
| <detaileddescription title=""/> | ||
| <memberdecl> | ||
| <nestednamespaces visible="yes" title=""/> | ||
| <constantgroups visible="yes" title=""/> | ||
| <interfaces visible="yes" title=""/> | ||
| <classes visible="yes" title=""/> | ||
| <concepts visible="yes" title=""/> | ||
| <structs visible="yes" title=""/> | ||
| <exceptions visible="yes" title=""/> | ||
| <typedefs title=""/> | ||
| <sequences title=""/> | ||
| <dictionaries title=""/> | ||
| <enums title=""/> | ||
| <functions title=""/> | ||
| <variables title=""/> | ||
| <properties title=""/> | ||
| <membergroups visible="yes"/> | ||
| </memberdecl> | ||
| <memberdef> | ||
| <inlineclasses title=""/> | ||
| <typedefs title=""/> | ||
| <sequences title=""/> | ||
| <dictionaries title=""/> | ||
| <enums title=""/> | ||
| <functions title=""/> | ||
| <variables title=""/> | ||
| <properties title=""/> | ||
| </memberdef> | ||
| <authorsection visible="yes"/> | ||
| </namespace> | ||
|
|
||
| <!-- Layout definition for a concept page --> | ||
| <concept> | ||
| <detaileddescription title=""/> | ||
| <includes visible="$SHOW_HEADERFILE"/> | ||
| <definition visible="yes" title=""/> | ||
| <authorsection visible="yes"/> | ||
| </concept> | ||
|
|
||
| <!-- Layout definition for a file page --> | ||
| <file> | ||
| <detaileddescription title=" "/> | ||
| <includes visible="$SHOW_INCLUDE_FILES"/> | ||
| <includegraph visible="yes"/> | ||
| <includedbygraph visible="yes"/> | ||
| <sourcelink visible="yes"/> | ||
| <memberdecl> | ||
| <interfaces visible="yes" title=""/> | ||
| <classes visible="yes" title=""/> | ||
| <structs visible="yes" title=""/> | ||
| <exceptions visible="yes" title=""/> | ||
| <namespaces visible="yes" title=""/> | ||
| <concepts visible="yes" title=""/> | ||
| <constantgroups visible="yes" title=""/> | ||
| <defines title=""/> | ||
| <typedefs title=""/> | ||
| <sequences title=""/> | ||
| <dictionaries title=""/> | ||
| <enums title=""/> | ||
| <functions title=""/> | ||
| <variables title=""/> | ||
| <properties title=""/> | ||
| <membergroups visible="yes"/> | ||
| </memberdecl> | ||
| <memberdef> | ||
| <inlineclasses title=""/> | ||
| <defines title=""/> | ||
| <typedefs title=""/> | ||
| <sequences title=""/> | ||
| <dictionaries title=""/> | ||
| <enums title=""/> | ||
| <functions title=""/> | ||
| <variables title=""/> | ||
| <properties title=""/> | ||
| </memberdef> | ||
| <authorsection/> | ||
| </file> | ||
|
|
||
| <!-- Layout definition for a group page --> | ||
| <group> | ||
| <detaileddescription title=""/> | ||
| <groupgraph visible="yes"/> | ||
| <memberdecl> | ||
| <nestedgroups visible="yes" title=""/> | ||
| <modules visible="yes" title=""/> | ||
| <dirs visible="yes" title=""/> | ||
| <files visible="yes" title=""/> | ||
| <namespaces visible="yes" title=""/> | ||
| <concepts visible="yes" title=""/> | ||
| <classes visible="yes" title=""/> | ||
| <defines title=""/> | ||
| <typedefs title=""/> | ||
| <sequences title=""/> | ||
| <dictionaries title=""/> | ||
| <enums title=""/> | ||
| <enumvalues title=""/> | ||
| <functions title=""/> | ||
| <variables title=""/> | ||
| <signals title=""/> | ||
| <publicslots title=""/> | ||
| <protectedslots title=""/> | ||
| <privateslots title=""/> | ||
| <events title=""/> | ||
| <properties title=""/> | ||
| <friends title=""/> | ||
| <membergroups visible="yes"/> | ||
| </memberdecl> | ||
| <memberdef> | ||
| <pagedocs/> | ||
| <inlineclasses title=""/> | ||
| <defines title=""/> | ||
| <typedefs title=""/> | ||
| <sequences title=""/> | ||
| <dictionaries title=""/> | ||
| <enums title=""/> | ||
| <enumvalues title=""/> | ||
| <functions title=""/> | ||
| <variables title=""/> | ||
| <signals title=""/> | ||
| <publicslots title=""/> | ||
| <protectedslots title=""/> | ||
| <privateslots title=""/> | ||
| <events title=""/> | ||
| <properties title=""/> | ||
| <friends title=""/> | ||
| </memberdef> | ||
| <authorsection visible="yes"/> | ||
| </group> | ||
|
|
||
| <!-- Layout definition for a C++20 module page --> | ||
| <module> | ||
| <detaileddescription title=""/> | ||
| <exportedmodules visible="yes"/> | ||
| <memberdecl> | ||
| <concepts visible="yes" title=""/> | ||
| <classes visible="yes" title=""/> | ||
| <enums title=""/> | ||
| <typedefs title=""/> | ||
| <functions title=""/> | ||
| <variables title=""/> | ||
| <membergroups title=""/> | ||
| </memberdecl> | ||
| <memberdecl> | ||
| <files visible="yes"/> | ||
| </memberdecl> | ||
| </module> | ||
|
|
||
| <!-- Layout definition for a directory page --> | ||
| <directory> | ||
| <detaileddescription title=""/> | ||
| <directorygraph visible="yes"/> | ||
| <memberdecl> | ||
| <dirs visible="yes"/> | ||
| <files visible="yes"/> | ||
| </memberdecl> | ||
| </directory> | ||
| </doxygenlayout> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| <!-- HTML footer for doxygen 1.10.0--> | ||
| <!-- start footer part --> | ||
| <!--BEGIN GENERATE_TREEVIEW--> | ||
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> | ||
| <ul> | ||
| $navpath | ||
| <li class="footer">$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion </li> | ||
| </ul> | ||
| </div> | ||
| <!--END GENERATE_TREEVIEW--> | ||
| <!--BEGIN !GENERATE_TREEVIEW--> | ||
| <hr class="footer"/><address class="footer"><small> | ||
| $generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion | ||
| </small></address> | ||
| <!--END !GENERATE_TREEVIEW--> | ||
| <script src="theme.js"></script> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| /* Fix scrollbar color */ | ||
| :root { color-scheme: dark } | ||
| @media (prefers-color-scheme: light) { | ||
| :root { color-scheme: light } | ||
| } | ||
|
|
||
| .memname { | ||
| font-family: var(--font-family-monospace); | ||
| } | ||
|
|
||
| /* The alias @evtapi is used to mark EVT API functions with a .evtapi child */ | ||
| .memitem:has(.evtapi) { | ||
| .memproto { | ||
| td.memname .el { display: none } | ||
| td.memname::before { content: "EVT_CALL(" } | ||
| td.memname::after { content: "," } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| // Make @evtapi prototype use EVT_CALL and params | ||
| for (const item of document.querySelectorAll(".memitem:has(.evtapi)")) { | ||
| // <a id="..." /> appears 2 children before item | ||
| const id = item.previousElementSibling.previousElementSibling.id | ||
|
|
||
| const tbody = item.querySelector(".memproto tbody") | ||
|
|
||
| const name = tbody.querySelector("td.memname").childNodes[1].textContent.trim() | ||
| const params = [`<a class="el" href="#${id}">${name}</a>`] | ||
|
|
||
| for (const param of item.querySelectorAll(".params .paramname")) { | ||
| params.push(param.textContent.trim()) | ||
| } | ||
|
|
||
| const proto = `EVT_CALL(${params.join(", ")})` | ||
| tbody.innerHTML = `<tr>${proto}</tr>` | ||
|
|
||
| // Find its link | ||
| const tr = document.getElementById(`r_${id}`) | ||
| tr.innerHTML = `<td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom">${proto}</td>` | ||
| } |
Oops, something went wrong.