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 11:55:48 UTC
svn commit: r1849840 - in /subversion/trunk: doc/
subversion/bindings/cxx/include/svnxx/
subversion/bindings/cxx/include/svnxx/detail/
subversion/bindings/cxx/src/aprwrap/ subversion/bindings/cxx/src/private/
Author: brane
Date: Fri Dec 28 11:55:48 2018
New Revision: 1849840
URL: http://svn.apache.org/viewvc?rev=1849840&view=rev
Log:
Adjust layout of SVN++ API internals to the documented state.
* doc/doxygen.conf (INPUT): Add new directory pattern.
[in subversion/bindings/cxx]
* include/svnxx/detail: New directory.
* include/svnxx/noncopyable.hpp: Moved from here ...
* include/svnxx/detail/noncopyable.hpp: ... to here.
Update docs and include guard.
* include/svnxx/detail/doxygen.hpp: New; document implementation details.
* src/aprwrap/pool.hpp,
src/private/init-private.hpp: Change include path of noncopyable.hpp.
Added:
subversion/trunk/subversion/bindings/cxx/include/svnxx/detail/
subversion/trunk/subversion/bindings/cxx/include/svnxx/detail/doxygen.hpp (with props)
subversion/trunk/subversion/bindings/cxx/include/svnxx/detail/noncopyable.hpp
- copied, changed from r1849839, subversion/trunk/subversion/bindings/cxx/include/svnxx/noncopyable.hpp
Removed:
subversion/trunk/subversion/bindings/cxx/include/svnxx/noncopyable.hpp
Modified:
subversion/trunk/doc/doxygen.conf
subversion/trunk/subversion/bindings/cxx/src/aprwrap/pool.hpp
subversion/trunk/subversion/bindings/cxx/src/private/init-private.hpp
Modified: subversion/trunk/doc/doxygen.conf
URL: http://svn.apache.org/viewvc/subversion/trunk/doc/doxygen.conf?rev=1849840&r1=1849839&r2=1849840&view=diff
==============================================================================
--- subversion/trunk/doc/doxygen.conf (original)
+++ subversion/trunk/doc/doxygen.conf Fri Dec 28 11:55:48 2018
@@ -579,6 +579,7 @@ WARN_LOGFILE =
INPUT = subversion/include \
subversion/bindings/cxx/include \
subversion/bindings/cxx/include/svnxx \
+ subversion/bindings/cxx/include/svnxx/detail \
subversion/include/private/svn_doxygen.h
# This tag can be used to specify the character encoding of the source files
Added: subversion/trunk/subversion/bindings/cxx/include/svnxx/detail/doxygen.hpp
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/cxx/include/svnxx/detail/doxygen.hpp?rev=1849840&view=auto
==============================================================================
--- subversion/trunk/subversion/bindings/cxx/include/svnxx/detail/doxygen.hpp (added)
+++ subversion/trunk/subversion/bindings/cxx/include/svnxx/detail/doxygen.hpp Fri Dec 28 11:55:48 2018
@@ -0,0 +1,51 @@
+/**
+ * @file svnxx/detail/doxygen.hpp
+ * @copyright
+ * ====================================================================
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ * ====================================================================
+ * @endcopyright
+ */
+
+#ifdef DOXYGEN
+
+namespace apache {
+namespace subversion {
+namespace svnxx {
+namespace detail {
+
+/**
+ * @defgroup svnxx_detail SVN++ Implementation Details
+ * @brief The C++ API's Private Parts
+ *
+ * The C++ API's Private Parts
+ * ===========================
+ *
+ * Anything declared or defined in the namespace
+ * @c apache::subversion::svnxx::detail is an implementation detail
+ * of the SVN++ public API. User code @b should @b not use anything
+ * from this namespace, except as far as it's referenced from the
+ * public parts of the API.
+ */
+
+} // namespace detail
+} // namespace svnxx
+} // namespace subversion
+} // namespace apache
+
+#endif // DOXYGEN
Propchange: subversion/trunk/subversion/bindings/cxx/include/svnxx/detail/doxygen.hpp
------------------------------------------------------------------------------
svn:eol-style = native
Copied: subversion/trunk/subversion/bindings/cxx/include/svnxx/detail/noncopyable.hpp (from r1849839, subversion/trunk/subversion/bindings/cxx/include/svnxx/noncopyable.hpp)
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/cxx/include/svnxx/detail/noncopyable.hpp?p2=subversion/trunk/subversion/bindings/cxx/include/svnxx/detail/noncopyable.hpp&p1=subversion/trunk/subversion/bindings/cxx/include/svnxx/noncopyable.hpp&r1=1849839&r2=1849840&rev=1849840&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/cxx/include/svnxx/noncopyable.hpp (original)
+++ subversion/trunk/subversion/bindings/cxx/include/svnxx/detail/noncopyable.hpp Fri Dec 28 11:55:48 2018
@@ -1,5 +1,5 @@
/**
- * @file svnxx/noncopyable.hpp
+ * @file svnxx/detail/noncopyable.hpp
* @copyright
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
@@ -22,8 +22,8 @@
* @endcopyright
*/
-#ifndef SVNXX_NONCOPYABLE_HPP
-#define SVNXX_NONCOPYABLE_HPP
+#ifndef SVNXX_DETAIL_NONCOPYABLE_HPP
+#define SVNXX_DETAIL_NONCOPYABLE_HPP
namespace apache {
namespace subversion {
@@ -31,11 +31,11 @@ namespace svnxx {
namespace detail {
namespace noncopyable_ {
-
/**
+ * @ingroup svnxx_detail
* @brief Base class for non-copyable objects.
*
- * Objects of classes derived from @c noncopyable cannot be copyed,
+ * Objects of classes derived from @c noncopyable cannot be copied,
* but can used as rvalue references and with <tt>std::move</tt>.
*
* @note Use @e private inheritance to avoid polymorphism traps!
@@ -58,4 +58,4 @@ using noncopyable = noncopyable_::noncop
} // namespace subversion
} // namespace apache
-#endif // SVNXX_NONCOPYABLE_HPP
+#endif // SVNXX_DETAIL_NONCOPYABLE_HPP
Modified: subversion/trunk/subversion/bindings/cxx/src/aprwrap/pool.hpp
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/cxx/src/aprwrap/pool.hpp?rev=1849840&r1=1849839&r2=1849840&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/cxx/src/aprwrap/pool.hpp (original)
+++ subversion/trunk/subversion/bindings/cxx/src/aprwrap/pool.hpp Fri Dec 28 11:55:48 2018
@@ -29,7 +29,7 @@
#include <memory>
#include "svnxx/exception.hpp"
-#include "svnxx/noncopyable.hpp"
+#include "svnxx/detail/noncopyable.hpp"
#include "svn_pools.h"
Modified: subversion/trunk/subversion/bindings/cxx/src/private/init-private.hpp
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/cxx/src/private/init-private.hpp?rev=1849840&r1=1849839&r2=1849840&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/cxx/src/private/init-private.hpp (original)
+++ subversion/trunk/subversion/bindings/cxx/src/private/init-private.hpp Fri Dec 28 11:55:48 2018
@@ -35,7 +35,7 @@
#include <apr_pools.h>
#include "svnxx/init.hpp"
-#include "svnxx/noncopyable.hpp"
+#include "svnxx/detail/noncopyable.hpp"
#include "svn_private_config.h"