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

[Jonathan Rose (JIRA)]

Jonathan Rose created ASTERISK-23178:
----------------------------------------

             Summary: 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
            Severity: Minor


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 is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.asterisk.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira