Docs: correct some comments
authorCampbell Barton <ideasman42@gmail.com>
Thu, 20 Aug 2015 23:07:52 +0000 (09:07 +1000)
committerCampbell Barton <ideasman42@gmail.com>
Thu, 20 Aug 2015 23:07:52 +0000 (09:07 +1000)
source/blender/blenloader/BLO_blend_defs.h
source/blender/editors/include/ED_view3d.h
source/blender/editors/space_view3d/view3d_edit.c

index 34a881bd7ccc09e8cc0e5e1a51f9791ea584d826..44f0fa9aa532e1e231f34d732c1a28e2e443af11 100644 (file)
@@ -42,7 +42,7 @@
 enum {
        /**
         * Arbitrary allocated memory
-        * (owned by #ID's, or will leak on exit)
+        * (typically owned by #ID's, will be freed when there are no users).
         */
        DATA = BLEND_MAKE_ID('D', 'A', 'T', 'A'),
        /**
@@ -55,8 +55,8 @@ enum {
         */
        DNA1 = BLEND_MAKE_ID('D', 'N', 'A', '1'),
        /**
-        * Used as preview between #REND and #GLOB,
-        * (ignored for regular file reading)
+        * Used to store thumbnail previews, written between #REND and #GLOB blocks,
+        * (ignored for regular file reading).
         */
        TEST = BLEND_MAKE_ID('T', 'E', 'S', 'T'),
        /**
index c3999d29f89391ea994faf6e9425326de1c16ecf..416e821b3f8b7d71fe06c70fc2c0aa79862e9a56 100644 (file)
@@ -276,10 +276,10 @@ unsigned int  ED_view3d_backbuf_sample_rect(
 int          ED_view3d_backbuf_sample_size_clamp(struct ARegion *ar, const float dist);
 unsigned int ED_view3d_backbuf_sample(struct ViewContext *vc, int x, int y);
 
-/* draws and does a 4x4 sample */
-bool ED_view3d_autodist(struct Scene *scene, struct ARegion *ar, struct View3D *v3d,
-                        const int mval[2], float mouse_worldloc[3],
-                        const bool alphaoverride, const float fallback_depth_pt[3]);
+bool ED_view3d_autodist(
+        struct Scene *scene, struct ARegion *ar, struct View3D *v3d,
+        const int mval[2], float mouse_worldloc[3],
+        const bool alphaoverride, const float fallback_depth_pt[3]);
 
 /* only draw so ED_view3d_autodist_simple can be called many times after */
 void ED_view3d_autodist_init(struct Scene *scene, struct ARegion *ar, struct View3D *v3d, int mode);
index 8d7596afc51ea09fbad6e2b37d9e0fecbd1d7ded..b330831ba9e20e52094746f87a6b64e6ce070849 100644 (file)
@@ -4818,10 +4818,17 @@ static float view_autodist_depth_margin(ARegion *ar, const int mval[2], int marg
        return depth_close;
 }
 
-/* XXX todo Zooms in on a border drawn by the user */
-bool ED_view3d_autodist(Scene *scene, ARegion *ar, View3D *v3d,
-                        const int mval[2], float mouse_worldloc[3],
-                        const bool alphaoverride, const float fallback_depth_pt[3])
+/**
+ * Get the world-space 3d location from a screen-space 2d point.
+ *
+ * \param mval: Input screen-space pixel location.
+ * \param mouse_worldloc: Output world-space loction.
+ * \param fallback_depth_pt: Use this points depth when no depth can be found.
+ */
+bool ED_view3d_autodist(
+        Scene *scene, ARegion *ar, View3D *v3d,
+        const int mval[2], float mouse_worldloc[3],
+        const bool alphaoverride, const float fallback_depth_pt[3])
 {
        bglMats mats; /* ZBuffer depth vars */
        float depth_close;