You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Stefan Küng <to...@gmail.com> on 2007/11/23 21:09:41 UTC

[PATCH] small documentation improvement

[[[
doxygen documentation: mention how to remove a config value

* Subversion/subversion/include/svn_config.h
]]]
Index: Subversion/subversion/include/svn_config.h
===================================================================
--- Subversion/subversion/include/svn_config.h	(revision 27993)
+++ Subversion/subversion/include/svn_config.h	(working copy)
@@ -200,6 +200,8 @@
   * @a value.
   *
   * This function invalidates all value expansions in @a cfg.
+ *
+ * To remove an option, pass NULL for the \c value.
   */
  void svn_config_set(svn_config_t *cfg,
                      const char *section, const char *option,


Stefan

-- 
        ___
   oo  // \\      "De Chelonian Mobile"
  (_,\/ \_/ \     TortoiseSVN
    \ \_/_\_/>    The coolest Interface to (Sub)Version Control
    /_/   \_\     http://tortoisesvn.net

Re: [PATCH] small documentation improvement

Posted by "Hyrum K. Wright" <hy...@mail.utexas.edu>.
Stefan Küng wrote:
> [[[
> doxygen documentation: mention how to remove a config value
> 
> * Subversion/subversion/include/svn_config.h
> ]]]
> Index: Subversion/subversion/include/svn_config.h
> ===================================================================
> --- Subversion/subversion/include/svn_config.h    (revision 27993)
> +++ Subversion/subversion/include/svn_config.h    (working copy)
> @@ -200,6 +200,8 @@
>   * @a value.
>   *
>   * This function invalidates all value expansions in @a cfg.
> + *
> + * To remove an option, pass NULL for the \c value.
>   */
>  void svn_config_set(svn_config_t *cfg,
>                      const char *section, const char *option,
> 

Committed in r27996.  I tweaked the patch (we use @c instead of \c) and
wrote a more complete doc string.

-Hyrum