You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@qpid.apache.org by "David Hickerson (JIRA)" <ji...@apache.org> on 2011/03/15 01:24:29 UTC

[jira] Updated: (QPID-3145) messaging::Message API needs to be documented, little to no Doxygen comments

     [ https://issues.apache.org/jira/browse/QPID-3145?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Hickerson updated QPID-3145:
----------------------------------

    Description: 
The documentation of everything in this class is represented by about 100 words, mostly representing the obvious that can be inferred by the method name. 

Questions:
1. Can you tell by calling getContentType whether to call getContent or getContentPtr or getProperties, or does that
   require the sender to set the content? 
2. If using the xml mentioned in the AMQP Messaging (Part 2), does Variant.getString() return that xml?
3. By setting TTL, Durable, Redelivered, what behavior does the system exhibit?
4. Does the broker modify any of the settings or are they only for use by the broker? MessageId?
5. Are there any conventions that should be followed for string data in this class that are used in other AMQP systems or language versions of Apid?
6. On getting the char* to the data on getContentPtr, what is the life of that data, are you expected to copy it or are you passed ownership responsibility?

  was:
The documentation of everything in this class is represented by about 100 words, mostly representing the obvious that can be inferred by the method name. 

Questions:
1. Can you tell by calling getContentType whether to call getContent or getContentPtr or getProperties, or does that
   require the sender to set the content? 
2. If using the xml mentioned in the AMQP Messaging (Part 2), does Variant.getString() return that xml?
3. By setting TTL, Durable, Redelivered, what behavior does the system exhibit?
4. Does the broker modify any of the settings or are they only for use by the broker? MessageId?
5. Are there any conventions that should be followed for string data in this class that are used in other AMQP systems or language versions of Apid?


> messaging::Message API needs to be documented, little to no Doxygen comments
> ----------------------------------------------------------------------------
>
>                 Key: QPID-3145
>                 URL: https://issues.apache.org/jira/browse/QPID-3145
>             Project: Qpid
>          Issue Type: Improvement
>          Components: C++ Client
>    Affects Versions: 0.8
>         Environment: C++ API
>            Reporter: David Hickerson
>              Labels: documentation
>   Original Estimate: 2h
>  Remaining Estimate: 2h
>
> The documentation of everything in this class is represented by about 100 words, mostly representing the obvious that can be inferred by the method name. 
> Questions:
> 1. Can you tell by calling getContentType whether to call getContent or getContentPtr or getProperties, or does that
>    require the sender to set the content? 
> 2. If using the xml mentioned in the AMQP Messaging (Part 2), does Variant.getString() return that xml?
> 3. By setting TTL, Durable, Redelivered, what behavior does the system exhibit?
> 4. Does the broker modify any of the settings or are they only for use by the broker? MessageId?
> 5. Are there any conventions that should be followed for string data in this class that are used in other AMQP systems or language versions of Apid?
> 6. On getting the char* to the data on getContentPtr, what is the life of that data, are you expected to copy it or are you passed ownership responsibility?

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project:      http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org