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 anchors to functions, types and states in the docs #671

Open
t-sommer opened this issue Nov 10, 2019 · 0 comments
Open

Add anchors to functions, types and states in the docs #671

t-sommer opened this issue Nov 10, 2019 · 0 comments
Labels
Milestone

Comments

@t-sommer
Copy link
Collaborator

@t-sommer t-sommer commented Nov 10, 2019

All FMI functions and types in the documentation should have an anchor with a pre-formatted xreflabel e.g.

[fmi3GetVersion,`fmi3GetVersion`]
[source, C]
----
include::../headers/fmi3FunctionTypes.h[tags=GetVersion]
----

so we can use it in the text, e.g.

The header file version number for which the model was compiled,
can be inquired in the target simulator with <<fmi3GetVersion>>.

and readers can conveniently navigate to the anchors.

@t-sommer t-sommer added the documents label Nov 10, 2019
@t-sommer t-sommer added this to the v3.0 milestone Nov 10, 2019
@chrbertsch chrbertsch changed the title Add anchors to functions and types in the docs Add anchors to functions, types and states in the docs Jan 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.