On Tue, Jun 12, 2001 at 04:03:01PM -0700, Dean Roddey wrote:
> It seems like people are getting kind of sloppy about include statements. I
> see a number of includes in the DOM that are in the form "xxx.hpp". This
> won't work in build systems which don't include the original source tree in
> the include path, i.e. they build out of tree. I believe that they should be
> in the standard form <dom/xxx.h>, so that it works the same whether its
> built out of tree or not.
Here some proposals which would make the life easier:
- You generate the documetation with doxygen. Unfortunatelly in the
description of a class the wrong (incomplete) include path is shown. This is
because you do not use the full qualified @class annotation:
For Example, for class AttributeList:
/**
* .. some docu stuff
*/
class AttributeList
{
...
};
this generates the following include statement in documentation
#include <AttributeList.hpp>
which is confusing wile I have (again and again) to look for the directory
where AttributeList.hpp lives
The solution:
doxygen already knows about this problems and offers a simple solution for it
/**
* @class AttributeList AttributeList.h sax/AttributeList.h
* .. some docu stuff
*/
class AttributeList
{
...
};
here the annotation will generate the right include statement in the
documentation
#include <sax/AttributeList.hpp>
- I wonder why there is no something like IstreamInputSource
----- cut -----
#ifdef XERCES_USE_STD_NS
#include <iostream>
using namespace std;
#else
#include <iostream.h>
#endif
class IstreamInputSource : public IstreamInputSource
{
public:
IstreamInputSource( istream &is, XMLCh const * const id);
IstreamInputSource( istream &is, char const * const id);
IstreamInputSource( istream &is);
BinInputStream* makeStream() const;
private:
istream &fIs;
};
----- cut -----
the macro XERCES_USE_STD_NS should be determined by configure script
together with IstreamBinInputStream in utils.
The implementation is (will be) stright forward: 50 lines of code for both
needed classes.
istream belongs to "Standard C++ Library".
I guess many people will be happy if they could parse C++ streams directly.
regards
--
Miroslaw Dobrzanski-Neumann
MOSAIC SOFTWARE AG
Base Development and Research
Tel +49-2225-882-291
Fax +49-2225-882-201
E-mail: [EMAIL PROTECTED]
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
