-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
44,851 changed files
with
5,594,694 additions
and
1 deletion.
The diff you're trying to view is too large. We only load the first 3000 changed files.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,9 @@ | ||
| # doc | ||
| # doc | ||
|
|
||
| This repository manages the API documentation of the bridges | ||
| clients. It maps to `bridgesuncc.github.io/doc` | ||
|
|
||
| You can generate the documentations using the script | ||
| `doc/make_doc.sh`. You have to be in `doc/` to run it. Note that the | ||
| script does not edit the current documentation. This is managed by | ||
| symlinks, for instance `doc/cxx-api/current`. |
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,194 @@ | ||
| <doxygenlayout version="1.0"> | ||
| <!-- Generated by doxygen 1.8.13 --> | ||
| <!-- Navigation index tabs for HTML output --> | ||
| <navindex> | ||
| <tab type="mainpage" visible="yes" title=""/> | ||
| <tab type="pages" visible="yes" title="" intro=""/> | ||
| <tab type="modules" visible="yes" title="" intro=""/> | ||
| <tab type="namespaces" visible="yes" title=""> | ||
| <tab type="namespacelist" visible="yes" title="" intro=""/> | ||
| <tab type="namespacemembers" 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="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> | ||
| <briefdescription visible="no"/> | ||
| <includes visible="$SHOW_INCLUDE_FILES"/> | ||
| <inheritancegraph visible="$CLASS_GRAPH"/> | ||
| <collaborationgraph visible="$COLLABORATION_GRAPH"/> | ||
| <detaileddescription title=""/> | ||
| <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> | ||
| <briefdescription visible="yes"/> | ||
| <memberdecl> | ||
| <nestednamespaces visible="yes" title=""/> | ||
| <constantgroups visible="yes" title=""/> | ||
| <classes visible="yes" title=""/> | ||
| <typedefs title=""/> | ||
| <enums title=""/> | ||
| <functions title=""/> | ||
| <variables title=""/> | ||
| <membergroups visible="yes"/> | ||
| </memberdecl> | ||
| <detaileddescription title=""/> | ||
| <memberdef> | ||
| <inlineclasses title=""/> | ||
| <typedefs title=""/> | ||
| <enums title=""/> | ||
| <functions title=""/> | ||
| <variables title=""/> | ||
| </memberdef> | ||
| <authorsection visible="yes"/> | ||
| </namespace> | ||
|
|
||
| <!-- Layout definition for a file page --> | ||
| <file> | ||
| <briefdescription visible="yes"/> | ||
| <includes visible="$SHOW_INCLUDE_FILES"/> | ||
| <includegraph visible="$INCLUDE_GRAPH"/> | ||
| <includedbygraph visible="$INCLUDED_BY_GRAPH"/> | ||
| <sourcelink visible="yes"/> | ||
| <memberdecl> | ||
| <classes visible="yes" title=""/> | ||
| <namespaces visible="yes" title=""/> | ||
| <constantgroups visible="yes" title=""/> | ||
| <defines title=""/> | ||
| <typedefs title=""/> | ||
| <enums title=""/> | ||
| <functions title=""/> | ||
| <variables title=""/> | ||
| <membergroups visible="yes"/> | ||
| </memberdecl> | ||
| <detaileddescription title=""/> | ||
| <memberdef> | ||
| <inlineclasses title=""/> | ||
| <defines title=""/> | ||
| <typedefs title=""/> | ||
| <enums title=""/> | ||
| <functions title=""/> | ||
| <variables title=""/> | ||
| </memberdef> | ||
| <authorsection/> | ||
| </file> | ||
|
|
||
| <!-- Layout definition for a group page --> | ||
| <group> | ||
| <briefdescription visible="yes"/> | ||
| <groupgraph visible="$GROUP_GRAPHS"/> | ||
| <memberdecl> | ||
| <nestedgroups visible="yes" title=""/> | ||
| <dirs visible="yes" title=""/> | ||
| <files visible="yes" title=""/> | ||
| <namespaces visible="yes" title=""/> | ||
| <classes visible="yes" title=""/> | ||
| <defines title=""/> | ||
| <typedefs 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> | ||
| <detaileddescription title=""/> | ||
| <memberdef> | ||
| <pagedocs/> | ||
| <inlineclasses title=""/> | ||
| <defines title=""/> | ||
| <typedefs 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 directory page --> | ||
| <directory> | ||
| <briefdescription visible="yes"/> | ||
| <directorygraph visible="yes"/> | ||
| <memberdecl> | ||
| <dirs visible="yes"/> | ||
| <files visible="yes"/> | ||
| </memberdecl> | ||
| <detaileddescription title=""/> | ||
| </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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| Documentation | ||
| ============= | ||
|
|
||
| The documentations of bridges client apis are not written manually. | ||
| The documentations are extracted automatically from the code of the | ||
| clients apis using doxygen and doxypy. | ||
|
|
||
| There is a script called ./make_doc.sh that takes 3 parameters, the local path to the git repositories of the three clienst. For instance, I run: | ||
|
|
||
| ``` | ||
| ./make_doc.sh ~/work/bridges/bridges-cxx/ ~/work/bridges/bridges-java/ ~/work/bridges/bridges-python/ | ||
| ``` | ||
|
|
||
| Note that there are protections in place to prevent running things passing the wrong repository. | ||
|
|
||
| The documentation is generated automatically with a version number | ||
| extracted from the git repositories. This is done by git-describe that | ||
| generate a string with a proper version number from tags such as | ||
| "3.1.1" if there is a tag on the most recent commit or | ||
| "3.1.0-22-gceb9977" if the most recent commit is not tagged. This | ||
| actually help us making sure we have a good mapping of documentation | ||
| to precise version of the codes rather than version numbering that | ||
| could be inconsistent. | ||
|
|
||
| The script does not change the content of the git index. That is to | ||
| say that you still need to git add the directories that have | ||
| changed. The "current" documentation pointers also do not get updates | ||
| automatically. These two "inconvenience" are on purpose to make sure | ||
| we do not publish/update documentations if we are just testing things. | ||
|
|
||
| Also, the ``make_doc.sh`` script updates the list of old | ||
| documentations. That list is generated by looking at the content of | ||
| the git repository. That means that add documentations after running | ||
| ``make_doc.sh``, they won't appear in the list of past | ||
| documentation. This probably is not a problem since they will be added | ||
| the next time the documentation is generated (so when they become | ||
| old). But if for some reason it is necessary to recreate the list of | ||
| old documentation, one can run: | ||
|
|
||
| ``` | ||
| ./generate_old_doc.sh > old_docs.html | ||
| ``` | ||
|
|
Oops, something went wrong.