aboutsummaryrefslogtreecommitdiff
path: root/contributing.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-12-04 14:01:01 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-12-04 14:01:01 +0100
commit210800c5fa71460d9cbcfff808a62cc07e0fdb7a (patch)
tree97116c78f7cdba5ee2ed601e9f2198ca8363b4a5 /contributing.md
parent0fa167fa3ee78f1e5379888114890c6a92cdaa25 (diff)
fix namespace type references + update contributing.md
Diffstat (limited to 'contributing.md')
-rw-r--r--contributing.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/contributing.md b/contributing.md
index 9f22c60..7dedaa7 100644
--- a/contributing.md
+++ b/contributing.md
@@ -983,18 +983,25 @@ following format:
- A **minimal** example to demonstrate how the feature is used. The example
should be written such that the following is clear to the reader:
- Which headers need to be included to utilize the feature
+ - *Why* the example works, not what is happening in the example
- Where is this code supposed to be called (e.g. inside scene/script
functions)
- - *Why* the example works, not what is happening in the example
- Which restrictions should be kept in mind (e.g. copy/move semantics, max
component instances, speed considerations)
Features should be documented as clear and concise as possible, so the following
points should be kept in mind:
-- If a page expands on an example from another page, directly reference the
- other page using a cross-reference (`\ref`) instead of writing a larger
- example
+- <details><summary>
+ If a page expands on an example from another page, directly reference the
+ other page using a cross-reference (`\ref`) in a `\note` block at the top of
+ the page.
+ </summary>
+
+ ```
+ \note This page builds on top of the example shown in \ref feature_script
+ ```
+ </details>
- When explaining the usage of specific functions, qualify them such that
Doxygen is able to add a cross-reference or manually add a reference using the
`\ref` command.