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

Refine and update documentation #468

Closed
3 tasks
dkroenke opened this issue Dec 29, 2020 · 0 comments · Fixed by #477
Closed
3 tasks

Refine and update documentation #468

dkroenke opened this issue Dec 29, 2020 · 0 comments · Fixed by #477
Assignees
@dkroenke
Labels
documentation Improvements or additions to documentation

Comments

@dkroenke
Copy link
Member

Brief feature description

iceoryx needs to improve on documentation for the end-user and early adopters. Important is to have an up-to-date documentation which gives users or contributors the right way.

Detailed information

  • update iceoryx-utils Readme
  • check all existing links
  • extend doxygen documentation and create a consistent build structure for it
@dkroenke dkroenke added the documentation Improvements or additions to documentation label Dec 29, 2020
@dkroenke dkroenke self-assigned this Dec 29, 2020
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Dec 29, 2020
@dkroenke
iox-eclipse-iceoryx#468 update iceoryx utils readme
a267eb8 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 remove doxyfiles
1274923 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 doxygen generation from cmake
8f100db 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 add cmake for doc example
0f9a2a6 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 add doc to tools script
02e2611 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 remove zero width characters
9a9f679 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 cmake fixups
1620db5 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 cmake documentation
7c3ffdf 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 add doxygen workflow
aaf0080 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 extend docu
b619266 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 integrate doxygen in build workflow
4c626c2 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 fix build workflow
f49d818 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 remove warnings
ffda744 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 4, 2021
@dkroenke
iox-eclipse-iceoryx#468 add latex package to build
edce604 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 5, 2021
@dkroenke
Merge branch 'master' of https://github.com/eclipse/iceoryx into iox-e…
eb41569 
…clipse-iceoryx#468-update-iceoryx-utils-readme
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 5, 2021
@dkroenke
iox-eclipse-iceoryx#468 update script and workflow files
8c1f980 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 5, 2021
@dkroenke
iox-eclipse-iceoryx#468 fix build workflow
2f4486a 
Signed-off-by: Dietrich Krönke <[email protected]>

iox-eclipse-iceoryx#468 remove warnings

Signed-off-by: Dietrich Krönke <[email protected]>

iox-eclipse-iceoryx#468 add latex package to build

Signed-off-by: Dietrich Krönke <[email protected]>

iox-eclipse-iceoryx#285 add more codecov parser options

Signed-off-by: Dietrich Krönke <[email protected]>

iox-eclipse-iceoryx#285 archive lcov artifacts

Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 5, 2021
@dkroenke
iox-eclipse-iceoryx#468 update script and workflow files
593c538 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 5, 2021
@dkroenke
iox-eclipse-iceoryx#468 adapting docu
aac983f 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 5, 2021
@dkroenke
iox-eclipse-iceoryx#468 adapting name
11a6c69 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 5, 2021
@dkroenke
iox-eclipse-iceoryx#468 add EOL
63dcbc6 
Signed-off-by: Dietrich Krönke <[email protected]>
@dkroenke dkroenke mentioned this issue Jan 5, 2021
Merged
19 tasks
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 5, 2021
@dkroenke
iox-eclipse-iceoryx#468 Merge branch 'master' into iox-eclipse-iceory…
9734b03 
…x#468-update-iceoryx-utils-readme

Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 5, 2021
@dkroenke
iox-eclipse-iceoryx#468 adapt copyright header
4c66eed 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 5, 2021
@dkroenke
iox-eclipse-iceoryx#468 add xml generation for iceoryx website
ee9c587 
Signed-off-by: Dietrich Krönke <[email protected]>
@MatthiasKillat MatthiasKillat mentioned this issue Jan 6, 2021
Closed
24 tasks
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 6, 2021
@dkroenke
iox-eclipse-iceoryx#468 more explicit cmake warning
da64b5e 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 6, 2021
@dkroenke
iox-eclipse-iceoryx#468 dkroenke lives in year 2021
07a34f9 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 6, 2021
@dkroenke
iox-eclipse-iceoryx#468 add more usual tags to the docu
d2d6eb5 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 7, 2021
@dkroenke
iox-eclipse-iceoryx#468 remove test comments from script
73dfb46 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 7, 2021
@dkroenke
iox-eclipse-iceoryx#468 generate doxygen without building iceoryx
eb8b0bc 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 7, 2021
@dkroenke
iox-eclipse-iceoryx#468 fix workflow build
b7df94c 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Jan 8, 2021
@dkroenke
iox-eclipse-iceoryx#468 fileheader and doxygen comments
8bdde80 
Signed-off-by: Dietrich Krönke <[email protected]>
dkroenke added a commit that referenced this issue Jan 8, 2021
@dkroenke
Merge pull request #477 from ApexAI/iox-#468-update-iceoryx-utils-readme
64fa389 
Iox #468 basic doxygen support in iceoryx
@mossmaurice mossmaurice mentioned this issue Apr 15, 2021
Closed
53 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dkroenke dkroenke

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Iox #468 basic doxygen support in iceoryx ApexAI/iceoryx
1 participant
@dkroenke