subversion-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From julianf...@apache.org
Subject svn commit: r1133811 - in /subversion/trunk/subversion/include: svn_config.h svn_dav.h svn_diff.h svn_error.h svn_error_codes.h
Date Thu, 09 Jun 2011 11:55:49 GMT
Author: julianfoad
Date: Thu Jun  9 11:55:48 2011
New Revision: 1133811

URL: http://svn.apache.org/viewvc?rev=1133811&view=rev
Log:
Update '@since' and '@deprecated' mark-up in some public headers.

* subversion/include/svn_config.h
  (SVN_CONFIG_OPTION_DIFF_EXTENSIONS,
   SVN_CONFIG_OPTION_FORCE_USERNAME_CASE): Add '@since'.

* subversion/include/svn_dav.h
  (SVN_SKEL_MIME_TYPE, SVN_DAV_*_HEADER): Add '@since' on constants that are
    new in 1.7.

* subversion/include/svn_diff.h
  (svn_diff_fns2_t): Add '@since'.

* subversion/include/svn_error_codes.h
  (SVN_ERR_WC_NOT_WORKING_COPY, SVN_ERR_WC_NOT_DIRECTORY): Adjust so that
    the description of replacement and deprecation is part of the '@since'
    and '@deprecated' paragraphs.

* subversion/include/svn_error.h
  (svn_error_return): Add '@since'.

Modified:
    subversion/trunk/subversion/include/svn_config.h
    subversion/trunk/subversion/include/svn_dav.h
    subversion/trunk/subversion/include/svn_diff.h
    subversion/trunk/subversion/include/svn_error.h
    subversion/trunk/subversion/include/svn_error_codes.h

Modified: subversion/trunk/subversion/include/svn_config.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_config.h?rev=1133811&r1=1133810&r2=1133811&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_config.h (original)
+++ subversion/trunk/subversion/include/svn_config.h Thu Jun  9 11:55:48 2011
@@ -97,6 +97,7 @@ typedef struct svn_config_t svn_config_t
 #define SVN_CONFIG_SECTION_HELPERS              "helpers"
 #define SVN_CONFIG_OPTION_EDITOR_CMD                "editor-cmd"
 #define SVN_CONFIG_OPTION_DIFF_CMD                  "diff-cmd"
+/** @since New in 1.7. */
 #define SVN_CONFIG_OPTION_DIFF_EXTENSIONS           "diff-extensions"
 #define SVN_CONFIG_OPTION_DIFF3_CMD                 "diff3-cmd"
 #define SVN_CONFIG_OPTION_DIFF3_HAS_PROGRAM_ARG     "diff3-has-program-arg"
@@ -127,6 +128,7 @@ typedef struct svn_config_t svn_config_t
 #define SVN_CONFIG_OPTION_PASSWORD_DB               "password-db"
 #define SVN_CONFIG_OPTION_REALM                     "realm"
 #define SVN_CONFIG_OPTION_AUTHZ_DB                  "authz-db"
+/** @since New in 1.7. */
 #define SVN_CONFIG_OPTION_FORCE_USERNAME_CASE       "force-username-case"
 #define SVN_CONFIG_SECTION_SASL                 "sasl"
 #define SVN_CONFIG_OPTION_USE_SASL                  "use-sasl"

Modified: subversion/trunk/subversion/include/svn_dav.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_dav.h?rev=1133811&r1=1133810&r2=1133811&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_dav.h (original)
+++ subversion/trunk/subversion/include/svn_dav.h Thu Jun  9 11:55:48 2011
@@ -47,6 +47,7 @@ extern "C" {
  *
  * This is an application type, for the "svn" vendor. The specific subtype
  * is "skel".
+ * @since New in 1.7.
  */
 #define SVN_SKEL_MIME_TYPE "application/vnd.svn-skel"
 
@@ -94,48 +95,56 @@ extern "C" {
 
 /** Assuming the OPTIONS was performed against a resource within a
  * Subversion repository, then this header indicates the youngest
- * revision in the repository.  */
+ * revision in the repository.
+ * @since New in 1.7.  */
 #define SVN_DAV_YOUNGEST_REV_HEADER "SVN-Youngest-Rev"
 
 /** Assuming the OPTIONS was performed against a resource within a
  * Subversion repository, then this header indicates the UUID of the
- * repository.  */
+ * repository.
+ * @since New in 1.7.  */
 #define SVN_DAV_REPOS_UUID_HEADER "SVN-Repository-UUID"
 
 /** Presence of this in a DAV header in an OPTIONS response indicates
  * that the server speaks HTTP protocol v2.  This header provides an
  * opaque URI that the client should send all custom REPORT requests
- * against.  */
+ * against.
+ * @since New in 1.7.  */
 #define SVN_DAV_ME_RESOURCE_HEADER "SVN-Me-Resource"
 
 /** This header provides the repository root URI, suitable for use in
  * calculating the relative paths of other public URIs for this
- * repository into .  (HTTP protocol v2 only)  */
+ * repository into .  (HTTP protocol v2 only)
+ * @since New in 1.7.  */
 #define SVN_DAV_ROOT_URI_HEADER "SVN-Repository-Root"
 
 /** This header provides an opaque URI that the client can append a
  * revision to, to construct a 'revision URL'.  This allows direct
  * read/write access to revprops via PROPFIND or PROPPATCH, and is
  * similar to libsvn_fs's revision objects (as distinct from "revision
- * roots").  (HTTP protocol v2 only)  */
+ * roots").  (HTTP protocol v2 only)
+ * @since New in 1.7.  */
 #define SVN_DAV_REV_STUB_HEADER "SVN-Rev-Stub"
 
 /** This header provides an opaque URI that the client can append
  * PEGREV/PATH to, in order to construct URIs of pegged objects in the
  * repository, similar to the use of a "revision root" in the
- * libsvn_fs API.  (HTTP protocol v2 only)  */
+ * libsvn_fs API.  (HTTP protocol v2 only)
+ * @since New in 1.7.  */
 #define SVN_DAV_REV_ROOT_STUB_HEADER "SVN-Rev-Root-Stub"
 
 /** This header provides an opaque URI which represents a Subversion
  * transaction (revision-in-progress) object.  It is suitable for use
  * in fetching and modifying transaction properties as part of a
  * commit process, similar to the svn_fs_txn_t object (as distinct
- * from a "txn root").  (HTTP protocol v2 only)  */
+ * from a "txn root").  (HTTP protocol v2 only)
+ * @since New in 1.7.  */
 #define SVN_DAV_TXN_STUB_HEADER "SVN-Txn-Stub"
 
 /** Companion to @c SVN_DAV_TXN_STUB_HEADER, used when a POST request
  *  returns @c SVN_DAV_VTXN_NAME_HEADER in response to a client
- *  supplied name.  (HTTP protocol v2 only)  */
+ *  supplied name.  (HTTP protocol v2 only)
+ * @since New in 1.7.  */
 #define SVN_DAV_VTXN_STUB_HEADER "SVN-VTxn-Stub"
 
 /** This header provides an opaque URI which represents the root
@@ -143,25 +152,29 @@ extern "C" {
  * similar to the concept of a "txn root" in the libsvn_fs API.  The
  * client can append additional path segments to it to access items
  * deeper in the transaction tree as part of a commit process.  (HTTP
- * protocol v2 only)  */
+ * protocol v2 only)
+ * @since New in 1.7.  */
 #define SVN_DAV_TXN_ROOT_STUB_HEADER "SVN-Txn-Root-Stub"
 
 /** Companion to @c SVN_DAV_TXN_ROOT_STUB_HEADER, used when a POST
  *  request returns @c SVN_DAV_VTXN_NAME_HEADER in response to a
- *  client supplied name.  (HTTP protocol v2 only)  */
+ *  client supplied name.  (HTTP protocol v2 only)
+ * @since New in 1.7.  */
 #define SVN_DAV_VTXN_ROOT_STUB_HEADER "SVN-VTxn-Root-Stub"
 
 /** This header is used in the POST response to tell the client the
  * name of the Subversion transaction created by the request.  It can
  * then be appended to the transaction stub and transaction root stub
  * for access to the properties and paths, respectively, of the named
- * transaction.  (HTTP protocol v2 only)  */
+ * transaction.  (HTTP protocol v2 only)
+ * @since New in 1.7.  */
 #define SVN_DAV_TXN_NAME_HEADER "SVN-Txn-Name"
 
 /** This header is used in the POST request, to pass a client supplied
  * alternative transaction name to the server, and in the the POST
  * response, to tell the client that the alternative transaction
- * resource names should be used.  (HTTP protocol v2 only)  */
+ * resource names should be used.  (HTTP protocol v2 only)
+ * @since New in 1.7.  */
 #define SVN_DAV_VTXN_NAME_HEADER "SVN-VTxn-Name"
 
 /**

Modified: subversion/trunk/subversion/include/svn_diff.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_diff.h?rev=1133811&r1=1133810&r2=1133811&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_diff.h (original)
+++ subversion/trunk/subversion/include/svn_diff.h Thu Jun  9 11:55:48 2011
@@ -104,7 +104,8 @@ typedef enum svn_diff_datasource_e
 } svn_diff_datasource_e;
 
 
-/** A vtable for reading data from the three datasources. */
+/** A vtable for reading data from the three datasources.
+ * @since New in 1.7. */
 typedef struct svn_diff_fns2_t
 {
   /** Open the datasources of type @a datasources. */

Modified: subversion/trunk/subversion/include/svn_error.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_error.h?rev=1133811&r1=1133810&r2=1133811&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_error.h (original)
+++ subversion/trunk/subversion/include/svn_error.h Thu Jun  9 11:55:48 2011
@@ -311,6 +311,8 @@ svn_handle_warning(FILE *stream,
  *
  * This macro can be used when directly returning an error to ensure
  * that the call stack is recorded correctly.
+ * 
+ * @since New in 1.7.
  */
 #ifdef SVN_ERR__TRACING
 #define SVN_ERR__TRACED "traced call"

Modified: subversion/trunk/subversion/include/svn_error_codes.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_error_codes.h?rev=1133811&r1=1133810&r2=1133811&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_error_codes.h (original)
+++ subversion/trunk/subversion/include/svn_error_codes.h Thu Jun  9 11:55:48 2011
@@ -375,15 +375,14 @@ SVN_ERROR_START
              SVN_ERR_WC_CATEGORY_START + 6,
              "Invalid lock")
 
- /** Previously this error number was used by #SVN_ERR_WC_NOT_DIRECTORY, which
-  * is now an alias for this error.
-  * @since Since 1.7. */
+  /** @since New in 1.7. Previously this error number was used by
+   * #SVN_ERR_WC_NOT_DIRECTORY, which is now an alias for this error. */
   SVN_ERRDEF(SVN_ERR_WC_NOT_WORKING_COPY,
              SVN_ERR_WC_CATEGORY_START + 7,
              "Path is not a working copy directory")
 
-  /** This name is deprecated. Use #SVN_ERR_WC_NOT_WORKING_COPY.
-   * @deprecated Provided for backward compatibility with the 1.6 API. */
+  /** @deprecated Provided for backward compatibility with the 1.6 API.
+   * Use #SVN_ERR_WC_NOT_WORKING_COPY. */
 #define SVN_ERR_WC_NOT_DIRECTORY SVN_ERR_WC_NOT_WORKING_COPY
 
   SVN_ERRDEF(SVN_ERR_WC_NOT_FILE,
@@ -476,7 +475,8 @@ SVN_ERROR_START
              "Failed to locate 'copyfrom' path in working copy")
 
   /** @since New in 1.5.
-   * @deprecated This event is not an error, and is now reported
+   * @deprecated Provided for backward compatibility with the 1.6 API.
+   * This event is not an error, and is now reported
    * via the standard notification mechanism instead. */
   SVN_ERRDEF(SVN_ERR_WC_CHANGELIST_MOVE,
              SVN_ERR_WC_CATEGORY_START + 29,



Mime
View raw message