[
https://issues.apache.org/jira/browse/QPID-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12634147#action_12634147
]
William Henry commented on QPID-1051:
-------------------------------------
I think there is a difference between violating the basic design of the
examples and having declarations for objects that aren't used and potentially
confusing.
If need be perhaps we could leave them in there but comment them out when not
used with a comment:
// Not used in this example.
Otherwise the new Qpid developer could get confused. And a tutorial that
confuses is not meeting its objectives.
> The C++ examples contain some typos and other mistakes that will confuse
> users. These are usability errors
> ----------------------------------------------------------------------------------------------------------
>
> Key: QPID-1051
> URL: https://issues.apache.org/jira/browse/QPID-1051
> Project: Qpid
> Issue Type: Bug
> Components: C++ Client
> Environment: n/a but Fedora 8 on a Thinkpad T61
> Reporter: William Henry
> Assignee: Alan Conway
> Priority: Minor
> Fix For: M4
>
> Attachments: diff_direct_declare_queues, diff_direct_listener,
> diff_fanout_listener, diff_fanout_producer, diff_pubsub_topic_listener,
> diff_pubsub_topic_publisher, diff_req-resp_server
>
>
> There are a few residual usability errors that seem to be the result of
> copying examples over and not cleaning up. None of these bugs stop the code
> from compiling or running but would cause usability problems for new users
> that are looking at the examples as templates on how to use qpid.
> E.g.
> Several files declare unused Message instances:
> Message message;
> Some files headers contain erroneous information. Either mentioning
> non-existent files or using incorrect names.
> I will attach some diff files that show the bugs in the code.
> request_response/server.cpp - declares a Message instance called message but
> doesn't use it.
> pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header
> but there is no such file.
> pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header
> but there is no such file. Message is declared and unused.
> fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message
> declared and unused
> fanout/producer.cpp - declare_queues.cpp mentioned in header and Message
> declared twice. One in try block is used.
> direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in
> header. Message declared and unused
> direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared
> and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
