From 1a5d5d8a7e796035bc70d5c727d4d901dda50726 Mon Sep 17 00:00:00 2001 From: "Jon A. Cruz" Date: Tue, 25 Oct 2011 00:45:35 -0700 Subject: Cleanup pass on documentation that was dumping garbage into doxygen output. (bzr r10696) --- src/io/base64stream.h | 10 ++++++---- src/io/gzipstream.h | 10 ++++++---- src/io/inkscapestream.h | 10 ++++------ src/io/resource.h | 7 ++++--- src/io/uristream.h | 10 ++++++---- src/io/xsltstream.h | 9 +++++---- 6 files changed, 31 insertions(+), 25 deletions(-) (limited to 'src/io') diff --git a/src/io/base64stream.h b/src/io/base64stream.h index 7bfe73e5f..554a92fe2 100644 --- a/src/io/base64stream.h +++ b/src/io/base64stream.h @@ -1,13 +1,15 @@ -#ifndef __INKSCAPE_IO_BASE64STREAM_H__ -#define __INKSCAPE_IO_BASE64STREAM_H__ +#ifndef SEEN_INKSCAPE_IO_BASE64STREAM_H +#define SEEN_INKSCAPE_IO_BASE64STREAM_H /** + * @file * Base64-enabled input and output streams * * This class allows easy encoding and decoding * of Base64 data with a stream interface, hiding * the implementation from the user. - * + */ +/* * Authors: * Bob Jamison * @@ -119,4 +121,4 @@ private: } // namespace Inkscape -#endif /* __INKSCAPE_IO_BASE64STREAM_H__ */ +#endif // SEEN_INKSCAPE_IO_BASE64STREAM_H diff --git a/src/io/gzipstream.h b/src/io/gzipstream.h index adaf50967..4debbfca9 100644 --- a/src/io/gzipstream.h +++ b/src/io/gzipstream.h @@ -1,12 +1,14 @@ -#ifndef __INKSCAPE_IO_GZIPSTREAM_H__ -#define __INKSCAPE_IO_GZIPSTREAM_H__ +#ifndef SEEN_INKSCAPE_IO_GZIPSTREAM_H +#define SEEN_INKSCAPE_IO_GZIPSTREAM_H /** - * Zlib-enabled input and output streams + * @file + * Zlib-enabled input and output streams. * * This is a thin wrapper of libz calls, in order * to provide a simple interface to our developers * for gzip input and output. - * + */ +/* * Authors: * Bob Jamison * diff --git a/src/io/inkscapestream.h b/src/io/inkscapestream.h index 9358b4d51..a766e16e0 100644 --- a/src/io/inkscapestream.h +++ b/src/io/inkscapestream.h @@ -1,8 +1,6 @@ -#ifndef __INKSCAPE_IO_INKSCAPESTREAM_H__ -#define __INKSCAPE_IO_INKSCAPESTREAM_H__ -/** - * Our base basic stream classes. - * +#ifndef SEEN_INKSCAPE_IO_INKSCAPESTREAM_H +#define SEEN_INKSCAPE_IO_INKSCAPESTREAM_H +/* * Authors: * Bob Jamison * @@ -667,4 +665,4 @@ void pipeStream(InputStream &source, OutputStream &dest); } // namespace Inkscape -#endif /* __INKSCAPE_IO_INKSCAPESTREAM_H__ */ +#endif // SEEN_INKSCAPE_IO_INKSCAPESTREAM_H diff --git a/src/io/resource.h b/src/io/resource.h index be3ff21b7..36fe5f81e 100644 --- a/src/io/resource.h +++ b/src/io/resource.h @@ -1,6 +1,4 @@ -/** \file - * Inkscape::IO::Resource - simple resource API - * +/* * Copyright 2006 MenTaLguY * * This program is free software; you can redistribute it and/or @@ -21,6 +19,9 @@ namespace Inkscape { namespace IO { +/** + * simple resource API + */ namespace Resource { enum Type { diff --git a/src/io/uristream.h b/src/io/uristream.h index d62065976..67d2f34d7 100644 --- a/src/io/uristream.h +++ b/src/io/uristream.h @@ -1,9 +1,11 @@ -#ifndef __INKSCAPE_IO_URISTREAM_H__ -#define __INKSCAPE_IO_URISTREAM_H__ +#ifndef SEEN_INKSCAPE_IO_URISTREAM_H +#define SEEN_INKSCAPE_IO_URISTREAM_H /** + * @file * This should be the only way that we provide sources/sinks * to any input/output stream. - * + */ +/* * Authors: * Bob Jamison * @@ -170,4 +172,4 @@ private: } // namespace Inkscape -#endif /* __INKSCAPE_IO_URISTREAM_H__ */ +#endif // SEEN_INKSCAPE_IO_URISTREAM_H diff --git a/src/io/xsltstream.h b/src/io/xsltstream.h index 32d9d12f8..03621c7fd 100644 --- a/src/io/xsltstream.h +++ b/src/io/xsltstream.h @@ -1,9 +1,10 @@ -#ifndef __INKSCAPE_IO_XSLTSTREAM_H__ -#define __INKSCAPE_IO_XSLTSTREAM_H__ +#ifndef SEEN_INKSCAPE_IO_XSLTSTREAM_H +#define SEEN_INKSCAPE_IO_XSLTSTREAM_H /** + * @file * Xslt-enabled input and output streams - * - * + */ +/* * Authors: * Bob Jamison * -- cgit v1.2.3