redirect: Doxygen and usage strings #58
Merged
Conversation
This file contains 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
cspiel1
force-pushed
the
redirect_usage_doxygen
branch
from
051cff5
to
7f8d0ec
Compare
maximilianfridrich
approved these changes
Dec 2, 2024
modules/redirect/redirect.c
Outdated
| * This module offers commands to set user absence information ("redirect") on | ||
| * UA basis that results in incoming call rejection with | ||
| * e.g. 302 Moved Temporarily. | ||
| * The status code and reason can be set. Also the Contact header with an |
There was a problem hiding this comment.
Maybe turn this into a list of what the user can specify. E.g.:
The user can specify:
- status code
- reason
- Contact header
- expiry value in seconds (after which the redirect is deleted)
- Optional Diversion parameters
The Diversion header is added automatically and its value is set to the account's aor.
modules/redirect/redirect.c
Outdated
| * config | ||
| * ------ | ||
| * | ||
| * The redirect module has to be loaded first, at least before module menu |
There was a problem hiding this comment.
This is important, maybe reword:
The redirect module MUST be loaded before the menu module.
7f8d0ec
to
3b26150
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.