[asterisk-dev] [Code Review] 2471: Basic res_sip XML documentation

[opticron]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/2471/#review8583
-----------------------------------------------------------



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16657>

    Change to "Communication with"



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16656>

    Change to "one or more contacts".



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16658>

    Change to "an 'aor' and configure"



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16659>

    Capitalize when starting sentences.



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16660>

    This should mention reINVITEs.



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16661>

    Change to "Method for setting up Direct Media between endpoints."



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16666>

    *Way(s)



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16668>

    VIA doesn't need to be in caps.



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16669>

    Change to "Interval at which to qualify an endpoint"



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16676>

    Change to "Lifetime of a nonce associated with this authorization section."



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16678>

    This is still here



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16689>

    The "TCP" in "(TCP ONLY)" should be "TCP/TLS" or "TLS".  If this information is going to be in options that are strictly related to the TCP/TLS transport, it should be in all of them including cert_file, ca_list_file, etc..



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16693>

    "Transport" here should be all lower case.



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16695>

    Make "Contact" all lower case.



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16697>

    This line doesn't flow correctly.



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16698>

    One 'l' in dialing.



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16694>

    Red blob.



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16701>

    Very good information to have!



trunk/res/res_sip.c
<https://reviewboard.asterisk.org/r/2471/#comment16703>

    make "AoR" all lower case here.



trunk/res/res_sip_acl.c
<https://reviewboard.asterisk.org/r/2471/#comment16704>

    Change the first part to "There are two main ways of creating an access list:".



trunk/res/res_sip_acl.c
<https://reviewboard.asterisk.org/r/2471/#comment16706>

    "possible to create"



trunk/res/res_sip_outbound_registration.c
<https://reviewboard.asterisk.org/r/2471/#comment16709>

    This is missing a verb.



trunk/res/res_sip_outbound_registration.c
<https://reviewboard.asterisk.org/r/2471/#comment16712>

    "Expiration time for registrations."



trunk/res/res_sip_outbound_registration.c
<https://reviewboard.asterisk.org/r/2471/#comment16713>

    "Maximum number of registration attempts."



trunk/res/res_sip_outbound_registration.c
<https://reviewboard.asterisk.org/r/2471/#comment16714>

    This seems to be missing a meaningful synopsis.



trunk/res/res_sip_outbound_registration.c
<https://reviewboard.asterisk.org/r/2471/#comment16716>

    This needs the word "used".



trunk/res/res_sip_outbound_registration.c
<https://reviewboard.asterisk.org/r/2471/#comment16718>

    If it isn't the configured transports, this needs to enumerate available options.


- opticron


On May 13, 2013, 2:54 a.m., Brad Latus wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviewboard.asterisk.org/r/2471/
> -----------------------------------------------------------
> 
> (Updated May 13, 2013, 2:54 a.m.)
> 
> 
> Review request for Asterisk Developers and Matt Jordan.
> 
> 
> Bugs: ASTERISK-21668
>     https://issues.asterisk.org/jira/browse/ASTERISK-21668
> 
> 
> Repository: Asterisk
> 
> 
> Description
> -------
> 
> Start of XML documentation for res_sip, not complete but a start.
> 
> 
> Diffs
> -----
> 
>   trunk/res/res_sip.c 387348 
>   trunk/res/res_sip_acl.c 387348 
>   trunk/res/res_sip_endpoint_identifier_ip.c 387348 
>   trunk/res/res_sip_outbound_registration.c 387348 
> 
> Diff: https://reviewboard.asterisk.org/r/2471/diff/
> 
> 
> Testing
> -------
> 
> Ran xmllint - no errors.
> No warnings about missing XML during asterisk startup.
> 
> 
> Thanks,
> 
> Brad Latus
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20130513/cf1309c9/attachment-0001.htm>