[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [44494] trunk/blender: move bmesh wiki docs into bmesh header and update doxygen.

Campbell Barton ideasman42 at gmail.com
Mon Feb 27 21:27:25 CET 2012


Revision: 44494
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=44494
Author:   campbellbarton
Date:     2012-02-27 20:27:19 +0000 (Mon, 27 Feb 2012)
Log Message:
-----------
move bmesh wiki docs into bmesh header and update doxygen.
also have doxygen ignore *.py files and fix some warnings.

Modified Paths:
--------------
    trunk/blender/GNUmakefile
    trunk/blender/doc/doxygen/Doxyfile
    trunk/blender/doc/doxygen/doxygen.source
    trunk/blender/source/blender/avi/AVI_avi.h
    trunk/blender/source/blender/blenkernel/BKE_idcode.h
    trunk/blender/source/blender/blenkernel/BKE_node.h
    trunk/blender/source/blender/blenkernel/BKE_tracking.h
    trunk/blender/source/blender/blenlib/intern/md5.c
    trunk/blender/source/blender/blenlib/intern/path_util.c
    trunk/blender/source/blender/blenlib/intern/string_utf8.c
    trunk/blender/source/blender/blenloader/intern/writefile.c
    trunk/blender/source/blender/bmesh/bmesh.h
    trunk/blender/source/blender/bmesh/bmesh_class.h
    trunk/blender/source/blender/bmesh/intern/bmesh_mods.c
    trunk/blender/source/blender/bmesh/intern/bmesh_structure.h
    trunk/blender/source/blender/collada/ExtraHandler.h
    trunk/blender/source/blender/collada/ExtraTags.h
    trunk/blender/source/blender/editors/include/BIF_glutil.h
    trunk/blender/source/blender/editors/space_clip/clip_toolbar.c
    trunk/blender/source/blender/editors/space_node/node_templates.c
    trunk/blender/source/blender/editors/uvedit/uvedit_smart_stitch.c
    trunk/blender/source/blender/imbuf/intern/IMB_metadata.h
    trunk/blender/source/blender/imbuf/intern/metadata.c

Removed Paths:
-------------
    trunk/blender/source/blender/bmesh/docs/

Modified: trunk/blender/GNUmakefile
===================================================================
--- trunk/blender/GNUmakefile	2012-02-27 18:20:58 UTC (rev 44493)
+++ trunk/blender/GNUmakefile	2012-02-27 20:27:19 UTC (rev 44494)
@@ -258,7 +258,7 @@
 	@echo "docs written into: '$(BLENDER_DIR)/doc/python_api/sphinx-out/contents.html'"
 
 doc_doxy:
-	cd doc/doxygen; doxygen 
+	cd doc/doxygen; doxygen Doxyfile
 	@echo "docs written into: '$(BLENDER_DIR)/doc/doxygen/html/index.html'"
 
 doc_dna:

Modified: trunk/blender/doc/doxygen/Doxyfile
===================================================================
--- trunk/blender/doc/doxygen/Doxyfile	2012-02-27 18:20:58 UTC (rev 44493)
+++ trunk/blender/doc/doxygen/Doxyfile	2012-02-27 20:27:19 UTC (rev 44494)
@@ -31,7 +31,7 @@
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.
 
-PROJECT_NUMBER         = "V2.59"
+PROJECT_NUMBER         = "V2.6x"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer
@@ -648,7 +648,7 @@
 # excluded from the INPUT source files. This way you can easily exclude a 
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = ../../source/gameengine/PyDoc
+EXCLUDE                = ../../build_files, ../../release
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
 # directories that are symbolic links (a Unix file system feature) are excluded 
@@ -662,7 +662,7 @@
 # against the file with absolute path, so to exclude all test directories 
 # for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       = .svn
+EXCLUDE_PATTERNS       = .svn .git *.py
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
 # (namespaces, classes, functions, etc.) that should be excluded from the 

Modified: trunk/blender/doc/doxygen/doxygen.source
===================================================================
--- trunk/blender/doc/doxygen/doxygen.source	2012-02-27 18:20:58 UTC (rev 44493)
+++ trunk/blender/doc/doxygen/doxygen.source	2012-02-27 20:27:19 UTC (rev 44494)
@@ -8,14 +8,14 @@
 /** \defgroup render Rendering
  *  \ingroup blender
  */
-/** \defgroup meshedit Mesh Editing */
+/** \defgroup bmesh BMesh
+ *  \ingroup blender
+ */
 /** \defgroup texture Texturing */
 /** \defgroup compositor Compositing */
 
-/** \defgroup scripts Scripting */
-
 /** \defgroup python Python
- *  \ingroup blender scripts
+ *  \ingroup blender
  */
 
 /** \defgroup pygen Python Generic
@@ -332,7 +332,7 @@
  *  \ingroup imbuf
  */
 
-/** \defgorup imbdds DDS
+/** \defgroup imbdds DDS
  *  \ingroup imbuf
  */
 

Modified: trunk/blender/source/blender/avi/AVI_avi.h
===================================================================
--- trunk/blender/source/blender/avi/AVI_avi.h	2012-02-27 18:20:58 UTC (rev 44493)
+++ trunk/blender/source/blender/avi/AVI_avi.h	2012-02-27 20:27:19 UTC (rev 44494)
@@ -249,7 +249,7 @@
 AviError AVI_close_compress (AviMovie *movie);
 
 /**
- * Choose a compression option for <movie>. Possible options are
+ * Choose a compression option for \<movie\>. Possible options are
  * AVI_OPTION_TYPE_MAIN, AVI_OPTION_TYPE_STRH, AVI_OPTION_TYPE_STRF
  */
 AviError AVI_set_compress_option (AviMovie *movie,
@@ -272,7 +272,7 @@
 #define AVI_OPTION_TYPE_STRF 2
 
 /**
- * Direct the streams <avist_type> to <movie>. Redirect <stream_num>
+ * Direct the streams \<avist_type\> to \<movie\>. Redirect \<stream_num\>
  * streams.
  */
 int AVI_get_stream (AviMovie *movie, int avist_type, int stream_num);

Modified: trunk/blender/source/blender/blenkernel/BKE_idcode.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_idcode.h	2012-02-27 18:20:58 UTC (rev 44493)
+++ trunk/blender/source/blender/blenkernel/BKE_idcode.h	2012-02-27 20:27:19 UTC (rev 44494)
@@ -77,7 +77,7 @@
 /**
  * Return an ID code and steps the index forward 1.
  *
- * @param index, start as 0.
+ * @param index start as 0.
  * @return the code, 0 when all codes have been returned.
  */
 int BKE_idcode_iter_step(int *index);

Modified: trunk/blender/source/blender/blenkernel/BKE_node.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_node.h	2012-02-27 18:20:58 UTC (rev 44493)
+++ trunk/blender/source/blender/blenkernel/BKE_node.h	2012-02-27 20:27:19 UTC (rev 44494)
@@ -165,7 +165,7 @@
 	/// Create a template from an existing node.
 	struct bNodeTemplate (*templatefunc)(struct bNode *);
 	/** If a node can be made from the template in the given node tree.
-	 * \example Node groups can not be created inside their own node tree.
+	 * \note Node groups can not be created inside their own node tree.
 	 */
 	int (*validfunc)(struct bNodeTree *ntree, struct bNodeTemplate *ntemp);
 	

Modified: trunk/blender/source/blender/blenkernel/BKE_tracking.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_tracking.h	2012-02-27 18:20:58 UTC (rev 44493)
+++ trunk/blender/source/blender/blenkernel/BKE_tracking.h	2012-02-27 20:27:19 UTC (rev 44494)
@@ -27,7 +27,7 @@
 #ifndef __BKE_TRACKING_H__
 #define __BKE_TRACKING_H__
 
-/** \file BKE_trackingp.h
+/** \file BKE_tracking.h
  *  \ingroup bke
  *  \author Sergey Sharybin
  */

Modified: trunk/blender/source/blender/blenlib/intern/md5.c
===================================================================
--- trunk/blender/source/blender/blenlib/intern/md5.c	2012-02-27 18:20:58 UTC (rev 44493)
+++ trunk/blender/source/blender/blenlib/intern/md5.c	2012-02-27 20:27:19 UTC (rev 44494)
@@ -1,6 +1,7 @@
-/** \file blender/imbuf/intern/md5.c
+/** \file blender/blenlib/intern/md5.c
  *  \ingroup imbuf
  */
+
 /* md5.c - Functions to compute MD5 message digest of files or memory blocks
    according to the definition of MD5 in RFC 1321 from April 1992.
    Copyright (C) 1995 Software Foundation, Inc.

Modified: trunk/blender/source/blender/blenlib/intern/path_util.c
===================================================================
--- trunk/blender/source/blender/blenlib/intern/path_util.c	2012-02-27 18:20:58 UTC (rev 44493)
+++ trunk/blender/source/blender/blenlib/intern/path_util.c	2012-02-27 20:27:19 UTC (rev 44494)
@@ -1855,6 +1855,7 @@
 * Also make sure the temp dir has a trailing slash
 *
 * @param fullname The full path to the temp directory
+* @param maxlen The size of the fullname buffer
 * @param userdir Directory specified in user preferences 
 */
 static void BLI_where_is_temp(char *fullname, const size_t maxlen, char *userdir)

Modified: trunk/blender/source/blender/blenlib/intern/string_utf8.c
===================================================================
--- trunk/blender/source/blender/blenlib/intern/string_utf8.c	2012-02-27 18:20:58 UTC (rev 44493)
+++ trunk/blender/source/blender/blenlib/intern/string_utf8.c	2012-02-27 20:27:19 UTC (rev 44494)
@@ -345,7 +345,7 @@
 /* was g_utf8_get_char */
 /**
  * BLI_str_utf8_as_unicode:
- * @p: a pointer to Unicode character encoded as UTF-8
+ * @p a pointer to Unicode character encoded as UTF-8
  *
  * Converts a sequence of bytes encoded as UTF-8 to a Unicode character.
  * If @p does not point to a valid UTF-8 encoded character, results are
@@ -432,10 +432,10 @@
 /* was g_unichar_to_utf8 */
 /**
  * BLI_str_utf8_from_unicode:
- * @c: a Unicode character code
- * @outbuf: output buffer, must have at least 6 bytes of space.
+ * @c a Unicode character code
+ * @param outbuf output buffer, must have at least 6 bytes of space.
  *       If %NULL, the length will be computed and returned
- *       and nothing will be written to @outbuf.
+ *       and nothing will be written to outbuf.
  *
  * Converts a single character to UTF-8.
  *
@@ -488,11 +488,11 @@
 /**
  * BLI_str_find_prev_char_utf8:
  * @str: pointer to the beginning of a UTF-8 encoded string
- * @p: pointer to some position within @str
+ * @p pointer to some position within @str
  *
  * Given a position @p with a UTF-8 encoded string @str, find the start
- * of the previous UTF-8 character starting before @p. Returns %NULL if no
- * UTF-8 characters are present in @str before @p.
+ * of the previous UTF-8 character starting before. @p Returns %NULL if no
+ * UTF-8 characters are present in @str before @p
  *
  * @p does not have to be at the beginning of a UTF-8 character. No check
  * is made to see if the character found is actually valid other than
@@ -513,11 +513,11 @@
 /* was g_utf8_find_next_char */
 /**
  * BLI_str_find_next_char_utf8:
- * @p: a pointer to a position within a UTF-8 encoded string
- * @end: a pointer to the byte following the end of the string,
+ * @p a pointer to a position within a UTF-8 encoded string
+ * @end a pointer to the byte following the end of the string,
  * or %NULL to indicate that the string is nul-terminated.
  *
- * Finds the start of the next UTF-8 character in the string after @p.
+ * Finds the start of the next UTF-8 character in the string after @p
  *
  * @p does not have to be at the beginning of a UTF-8 character. No check
  * is made to see if the character found is actually valid other than
@@ -545,9 +545,9 @@
 /* was g_utf8_prev_char */
 /**
  * BLI_str_prev_char_utf8:
- * @p: a pointer to a position within a UTF-8 encoded string
+ * @p a pointer to a position within a UTF-8 encoded string
  *
- * Finds the previous UTF-8 character in the string before @p.
+ * Finds the previous UTF-8 character in the string before @p
  *
  * @p does not have to be at the beginning of a UTF-8 character. No check
  * is made to see if the character found is actually valid other than

Modified: trunk/blender/source/blender/blenloader/intern/writefile.c
===================================================================
--- trunk/blender/source/blender/blenloader/intern/writefile.c	2012-02-27 18:20:58 UTC (rev 44493)
+++ trunk/blender/source/blender/blenloader/intern/writefile.c	2012-02-27 20:27:19 UTC (rev 44494)
@@ -285,7 +285,8 @@
 /**
  * BeGiN initializer for mywrite
  * @param file File descriptor
- * @param write_flags Write parameters
+ * @param compare Previous memory file (can be NULL).
+ * @param current The current memory file (can be NULL).
  * @warning Talks to other functions with global parameters
  */

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list