[asterisk-bugs] [JIRA] (ASTERISK-23178) devicestate.h: device state setting functions are documented with the wrong return values

[Matt Jordan (JIRA)]

     [ https://issues.asterisk.org/jira/browse/ASTERISK-23178?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Matt Jordan updated ASTERISK-23178:
-----------------------------------

    Target Release Version/s: 1.8.27.0

> devicestate.h: device state setting functions are documented with the wrong return values
> -----------------------------------------------------------------------------------------
>
>                 Key: ASTERISK-23178
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-23178
>             Project: Asterisk
>          Issue Type: Bug
>      Security Level: None
>          Components: Documentation
>    Affects Versions: SVN
>            Reporter: Jonathan Rose
>            Assignee: Richard Mudgett
>            Severity: Minor
>      Target Release: 1.8.27.0, 12.1.0
>
>
> Numerous functions in devicestate.h involving the setting of device state are currently documented with incorrect return values.  The principle culprit is that ast_devstate_changed_literal is documented with the following return codes
> -1 = failure
>  0 = success
> In reality, it returns 1 unconditionally. This has a cascading effect because the other ast_devstate_changed/ast_device_state_changed functions are usually just wrappers around ast_devstate_changed_literal.
> I haven't checked to see if this is a problem in earlier versions of Asterisk yet.



--
This message was sent by Atlassian JIRA
(v6.2#6252)