-
Notifications
You must be signed in to change notification settings - Fork 17
add documentation examples #58
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
Merged
RolandJentschETAS
merged 38 commits into
main
from
improvement_add_documentation_examples
Apr 23, 2026
Merged
Changes from 13 commits
Commits
Show all changes
38 commits
Select commit
Hold shift + click to select a range
a4b9193
add documentation examples
RolandJentschETAS d663e72
fix copyright check
RolandJentschETAS bf89f92
add copyright
RolandJentschETAS 683d5df
add newline at end of file
RolandJentschETAS c23e2f9
Revert "add newline at end of file"
RolandJentschETAS 87736d6
add newlines
RolandJentschETAS dd338b2
take over general structure according to process
RolandJentschETAS a368dd9
use folder template from process repo
RolandJentschETAS ef83c1f
fix commit hash
RolandJentschETAS 90b3293
fix strange format error
RolandJentschETAS 3e7930d
structuring module documentation
RolandJentschETAS 932dd61
add directory tree picture
RolandJentschETAS 32f0836
add some comments
RolandJentschETAS 66f9fae
change to include folder approach
RolandJentschETAS f00943c
use main path instead of link
RolandJentschETAS e781916
fix builds
RolandJentschETAS 60aa73e
remove stakeholder reqs
RolandJentschETAS c14608e
remove stakeholder reqs
RolandJentschETAS eff3896
temp fix for docs at root
AlexanderLanin e981b1d
fix links
RolandJentschETAS 7f4f5b5
add any necessary files
RolandJentschETAS bfee7e5
add main index file
RolandJentschETAS 6fd9311
move aou
RolandJentschETAS 59bc409
move aou
RolandJentschETAS 45b433d
update folder structure entry picture
RolandJentschETAS 778b735
empty gitkeep
RolandJentschETAS 4fd4bcf
rework test folders
RolandJentschETAS 590638c
small adaption of the folder structure
RolandJentschETAS ea1cf04
remove CR content
RolandJentschETAS 6f7f588
remove CR content
RolandJentschETAS 668691f
move verification
RolandJentschETAS db86d4e
add review results
RolandJentschETAS c1bec9b
minor changes
RolandJentschETAS 9d9611f
add hints
RolandJentschETAS 9d90c3b
add missing wp
RolandJentschETAS 31ed8a9
add hint
RolandJentschETAS 91e451f
fix review findings
RolandJentschETAS 70b1e0e
add notes
RolandJentschETAS File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or 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 hidden or 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,71 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2025 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| AoU Requirements Template | ||
| ========================= | ||
|
|
||
| This page contains Assumption of Use requirement snippets that belong to the | ||
| template repository. | ||
|
|
||
| Platform AoU | ||
| ------------ | ||
|
|
||
| .. code-block:: rst | ||
|
|
||
| .. aou_req:: Some Other Title | ||
| :id: aou_req__platform__some_other_title | ||
| :reqtype: Interface | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: invalid | ||
|
|
||
| The Platform User shall do xyz to use the platform safely. | ||
|
|
||
| Feature AoU | ||
| ----------- | ||
|
|
||
| .. code-block:: rst | ||
|
|
||
| .. aou_req:: Some Other Title | ||
| :id: aou_req__feature_name__some_other_title | ||
| :reqtype: Process | ||
| :security: NO | ||
| :safety: ASIL_B | ||
| :status: invalid | ||
|
|
||
| The Feature User shall do xyz to use the feature safely. | ||
|
|
||
| Component AoU | ||
| ------------- | ||
|
|
||
| .. code-block:: rst | ||
|
|
||
| .. aou_req:: Next Title | ||
| :id: aou_req__mod_temp_component_name__next_title | ||
| :reqtype: Process | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: invalid | ||
|
|
||
| The Component User shall do xyz to use the component safely/securely | ||
|
|
||
| .. aou_req:: Another Title | ||
| :id: aou_req__mod_temp_component_name__another | ||
| :reqtype: Process | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: invalid | ||
| :tags: environment | ||
|
|
||
| The Component shall only be used in a xyz environment to ensure its proper functioning. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I know doxygen is not used currently.
OR am I on old information?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is unchanged (was there also before PR). We have to check that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Implementation process is not finalised yet, that was planned for implementation, detailed design