You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by br...@apache.org on 2018/12/28 10:53:03 UTC
svn commit: r1849834 - in /subversion/trunk/subversion/bindings/cxx/include:
svnxx.hpp svnxx/depth.hpp svnxx/exception.hpp svnxx/init.hpp
svnxx/noncopyable.hpp svnxx/revision.hpp svnxx/tristate.hpp
Author: brane
Date: Fri Dec 28 10:53:02 2018
New Revision: 1849834
URL: http://svn.apache.org/viewvc?rev=1849834&view=rev
Log:
Minor documentation tweaks in SVN++.
[in subversion/bindings/cxx/include]
* svnxx.hpp: Add @file tag. Remove C++ check.
* svnxx/depth.hp: Add @file tag. Fix comment at end of include guard.
* svnxx/exception.hpp: Add @file tag. Change the title of the
svnxx_exceptions group and add a @brief description to avoid seeing the
heading-formatted description in summary lists. Also explain that
the implementation can throw standard exceptions.
* svnxx/init.hpp: Add @file tag. Remove C++ check.
* svnxx/noncopyable.hpp: Add @file tag.
* svnxx/tristate.hpp: Add @file tag. Remove C++ check.
Modified:
subversion/trunk/subversion/bindings/cxx/include/svnxx.hpp
subversion/trunk/subversion/bindings/cxx/include/svnxx/depth.hpp
subversion/trunk/subversion/bindings/cxx/include/svnxx/exception.hpp
subversion/trunk/subversion/bindings/cxx/include/svnxx/init.hpp
subversion/trunk/subversion/bindings/cxx/include/svnxx/noncopyable.hpp
subversion/trunk/subversion/bindings/cxx/include/svnxx/revision.hpp
subversion/trunk/subversion/bindings/cxx/include/svnxx/tristate.hpp
Modified: subversion/trunk/subversion/bindings/cxx/include/svnxx.hpp
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/cxx/include/svnxx.hpp?rev=1849834&r1=1849833&r2=1849834&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/cxx/include/svnxx.hpp (original)
+++ subversion/trunk/subversion/bindings/cxx/include/svnxx.hpp Fri Dec 28 10:53:02 2018
@@ -1,4 +1,5 @@
/**
+ * @file svnxx.hpp
* @copyright
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
@@ -21,10 +22,6 @@
* @endcopyright
*/
-#ifndef __cplusplus
-#error "This is a C++ header file."
-#endif
-
#ifndef SVNXX_HPP
#define SVNXX_HPP
Modified: subversion/trunk/subversion/bindings/cxx/include/svnxx/depth.hpp
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/cxx/include/svnxx/depth.hpp?rev=1849834&r1=1849833&r2=1849834&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/cxx/include/svnxx/depth.hpp (original)
+++ subversion/trunk/subversion/bindings/cxx/include/svnxx/depth.hpp Fri Dec 28 10:53:02 2018
@@ -1,4 +1,5 @@
/**
+ * @file svnxx/depth.hpp
* @copyright
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
@@ -73,4 +74,4 @@ std::u32string to_u32string(depth);
} // namespace subversion
} // namespace apache
-#endif // SVNXX_CLIENT_HPP
+#endif // SVNXX_DEPTH_HPP
Modified: subversion/trunk/subversion/bindings/cxx/include/svnxx/exception.hpp
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/cxx/include/svnxx/exception.hpp?rev=1849834&r1=1849833&r2=1849834&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/cxx/include/svnxx/exception.hpp (original)
+++ subversion/trunk/subversion/bindings/cxx/include/svnxx/exception.hpp Fri Dec 28 10:53:02 2018
@@ -1,4 +1,5 @@
/**
+ * @file svnxx/exception.hpp
* @copyright
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
@@ -32,7 +33,8 @@
#include <vector>
/**
- * @defgroup svnxx_exceptions Exceptions
+ * @defgroup svnxx_exceptions SVN++ Exceptions
+ * @brief Exceptions in SVN++
*
* Exceptions in SVN++
* ===================
@@ -52,6 +54,9 @@
* user-level callbacks will be propagated back to the calling
* application.
*
+ * The SVN++ implementation will also throw standard exceptions when
+ * appropriate. Their use is documented in the relevant modules.
+ *
* Exception Hierarchy
* -------------------
*
Modified: subversion/trunk/subversion/bindings/cxx/include/svnxx/init.hpp
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/cxx/include/svnxx/init.hpp?rev=1849834&r1=1849833&r2=1849834&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/cxx/include/svnxx/init.hpp (original)
+++ subversion/trunk/subversion/bindings/cxx/include/svnxx/init.hpp Fri Dec 28 10:53:02 2018
@@ -1,4 +1,5 @@
/**
+ * @file svnxx/init.hpp
* @copyright
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
@@ -21,10 +22,6 @@
* @endcopyright
*/
-#ifndef __cplusplus
-#error "This is a C++ header file."
-#endif
-
#ifndef SVNXX_INIT_HPP
#define SVNXX_INIT_HPP
Modified: subversion/trunk/subversion/bindings/cxx/include/svnxx/noncopyable.hpp
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/cxx/include/svnxx/noncopyable.hpp?rev=1849834&r1=1849833&r2=1849834&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/cxx/include/svnxx/noncopyable.hpp (original)
+++ subversion/trunk/subversion/bindings/cxx/include/svnxx/noncopyable.hpp Fri Dec 28 10:53:02 2018
@@ -1,4 +1,5 @@
/**
+ * @file svnxx/noncopyable.hpp
* @copyright
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
Modified: subversion/trunk/subversion/bindings/cxx/include/svnxx/revision.hpp
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/cxx/include/svnxx/revision.hpp?rev=1849834&r1=1849833&r2=1849834&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/cxx/include/svnxx/revision.hpp (original)
+++ subversion/trunk/subversion/bindings/cxx/include/svnxx/revision.hpp Fri Dec 28 10:53:02 2018
@@ -1,4 +1,5 @@
/**
+ * @file svnxx/revision.hpp
* @copyright
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
Modified: subversion/trunk/subversion/bindings/cxx/include/svnxx/tristate.hpp
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/cxx/include/svnxx/tristate.hpp?rev=1849834&r1=1849833&r2=1849834&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/cxx/include/svnxx/tristate.hpp (original)
+++ subversion/trunk/subversion/bindings/cxx/include/svnxx/tristate.hpp Fri Dec 28 10:53:02 2018
@@ -1,4 +1,5 @@
/**
+ * @file svnxx/tristate.hpp
* @copyright
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
@@ -21,10 +22,6 @@
* @endcopyright
*/
-#ifndef __cplusplus
-#error "This is a C++ header file."
-#endif
-
#ifndef SVNXX_TRISTATE_HPP
#define SVNXX_TRISTATE_HPP