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

doc: optimized struct-entry comments #9

Merged
merged 1 commit into from
Sep 18, 2023
Merged

doc: optimized struct-entry comments #9

merged 1 commit into from
Sep 18, 2023

Conversation

seehma
Copy link
Contributor

@seehma seehma commented Sep 18, 2023

Here is a second PR for struct-comments. (every variable comment, no matter if it is in an VAR_INPUT myVar : BOOL; //< blabla END_VAR or a method should be done in that way.
These comments should no show up in the description section of your struct-api-doc.

However, it should also work with three / above of the to-be-commented-variable. We are looking into this...

@seehma
Copy link
Contributor Author

seehma commented Sep 18, 2023

ok, we fixed this one, should now also work with tripple / above the variables...

@bengeisler bengeisler merged commit 1ff0545 into bengeisler:zeugwerk-docs Sep 18, 2023
1 check failed
@seehma seehma deleted the doc/struct-doc branch September 18, 2023 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants