doc: add deprecation notice on deprecated pseudo-modules#18698
Merged
miri64 merged 1 commit intoRIOT-OS:masterfrom Oct 6, 2022
Merged
doc: add deprecation notice on deprecated pseudo-modules#18698miri64 merged 1 commit intoRIOT-OS:masterfrom
miri64 merged 1 commit intoRIOT-OS:masterfrom
Conversation
Murdock results✔️ PASSED bb92b2b doc: add deprecation notice on deprecated pseudo-modules
ArtifactsThis only reflects a subset of all builds from https://ci-prod.riot-os.org. Please refer to https://ci.riot-os.org for a complete build for now. |
miri64
commented
Oct 6, 2022
Comment on lines
+81
to
+87
| ## @addtogroup net_gcoap_dns | ||
| ## @{ | ||
| ## Enable the @ref gcoap_dns function | ||
| PSEUDOMODULES += gcoap_dns | ||
| ## Enable the @ref gcoap_dns_server_proxy_set function | ||
| PSEUDOMODULES += gcoap_dns_proxied | ||
| ## @} |
Member
Author
There was a problem hiding this comment.
Those lines were added, because otherwise Doxygen would include these to gnrc_netdev_default's documentation.
Comment on lines
-45
to
+46
| * Finally, the module `event_thread_lowest` is provided for backward | ||
| * compatibility and has no effect. | ||
| * Finally, the module [event_thread_lowest](@ref sys_event_thread_lowest) is | ||
| * provided for backward compatibility and has no effect. |
Member
Author
There was a problem hiding this comment.
Mainly added this here, so the missing reference will be caught, once event_thread_lowest is removed in earnest.
6a7b911 to
0cde109
Compare
chrysn
reviewed
Oct 6, 2022
chrysn
reviewed
Oct 6, 2022
chrysn
reviewed
Oct 6, 2022
ff55ac0 to
bb92b2b
Compare
chrysn
approved these changes
Oct 6, 2022
Member
chrysn
left a comment
There was a problem hiding this comment.
Looks good enough, and any prettiness shortcomings are better addressed on the level of the pseudomodules documentation.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Contribution description
Alternative to the non-semantical page introduced in #18649.
Testing procedure
make docand look at the resultingdoc/doxygen/html/deprecated.html(or see documentation artifcats in #18698 (comment)).Issues/PRs references
Alternative to a proposal in #18649.