Include files - no clear design
-------------------------------
Key: QPID-1299
URL: https://issues.apache.org/jira/browse/QPID-1299
Project: Qpid
Issue Type: Improvement
Components: C++ Client
Reporter: Jonathan Robie
I'm trying to document which include files are needed in a C++ client.
Previously, I provided a template in the tutorial that worked for the programs
in the tutorial, and the template contained includes not needed by many
programs. I've been asked to optimize my use of include files.
I know two basic design strategies for include files in C++. One approach is to
have an include for every class used - this avoids bringing in unneeded
includes to optimize build times, and it's easy to tell the user what to do
(using a class? do an include for that class...). Another approach is to have a
global include, e.g. we might have a client/Qpid.h that contains all clases in
the qpid::client namespace - and this can be in addition to the other includes.
What we have falls somewhere in between. It's hard to explain to a programmer
when they need an include and when they do not.
My preferred solution is to provide both (1) more precise includes that do not
include superfluous files, and (2) a client/Qpid.h that includes all classes in
the qpid::client namespace.
Jonathan
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
