diff options
173 files changed, 794 insertions, 1673 deletions
diff --git a/release/scripts/startup/bl_ui/properties_game.py b/release/scripts/startup/bl_ui/properties_game.py index ee5702e324e..16e14a7ead4 100644 --- a/release/scripts/startup/bl_ui/properties_game.py +++ b/release/scripts/startup/bl_ui/properties_game.py @@ -329,7 +329,7 @@ class RENDER_PT_game_stereo(RenderButtonsPanel, Panel): col.prop(gs, "dome_angle", slider=True) col = split.column() - col.prop(gs, "dome_tesselation", text="Tesselation") + col.prop(gs, "dome_tessellation", text="Tessellation") col.prop(gs, "dome_tilt") elif dome_type == 'PANORAM_SPH': @@ -337,7 +337,7 @@ class RENDER_PT_game_stereo(RenderButtonsPanel, Panel): col.prop(gs, "dome_buffer_resolution", text="Resolution", slider=True) col = split.column() - col.prop(gs, "dome_tesselation", text="Tesselation") + col.prop(gs, "dome_tessellation", text="Tessellation") else: # cube map col = split.column() diff --git a/source/blender/blenkernel/BKE_DerivedMesh.h b/source/blender/blenkernel/BKE_DerivedMesh.h index 3103dde31dc..dff783c1b9b 100644 --- a/source/blender/blenkernel/BKE_DerivedMesh.h +++ b/source/blender/blenkernel/BKE_DerivedMesh.h @@ -133,8 +133,8 @@ struct DerivedMesh { /* calculate vert and face normals */ void (*calcNormals)(DerivedMesh *dm); - /* recalculates mesh tesselation */ - void (*recalcTesselation)(DerivedMesh *dm); + /* recalculates mesh tessellation */ + void (*recalcTessellation)(DerivedMesh *dm); /* Misc. Queries */ @@ -407,19 +407,19 @@ struct DerivedMesh { void (*release)(DerivedMesh *dm); }; -/* utility function to initialise a DerivedMesh's function pointers to +/* utility function to initialize a DerivedMesh's function pointers to * the default implementation (for those functions which have a default) */ void DM_init_funcs(DerivedMesh *dm); -/* utility function to initialise a DerivedMesh for the desired number +/* utility function to initialize a DerivedMesh for the desired number * of vertices, edges and faces (doesn't allocate memory for them, just * sets up the custom data layers) */ void DM_init(DerivedMesh *dm, DerivedMeshType type, int numVerts, int numEdges, int numFaces, int numLoops, int numPolys); -/* utility function to initialise a DerivedMesh for the desired number +/* utility function to initialize a DerivedMesh for the desired number * of vertices, edges and faces, with a layer setup copied from source */ void DM_from_template(DerivedMesh *dm, DerivedMesh *source, diff --git a/source/blender/blenkernel/BKE_cdderivedmesh.h b/source/blender/blenkernel/BKE_cdderivedmesh.h index 5fda391cd80..8ece5f14a96 100644 --- a/source/blender/blenkernel/BKE_cdderivedmesh.h +++ b/source/blender/blenkernel/BKE_cdderivedmesh.h @@ -106,13 +106,13 @@ void CDDM_calc_normals_tessface(struct DerivedMesh *dm); */ void CDDM_calc_edges_tessface(struct DerivedMesh *dm); -/* same as CDDM_calc_edges_tessface only makes edges from ngon faces instead of tesselation +/* same as CDDM_calc_edges_tessface only makes edges from ngon faces instead of tessellation faces*/ void CDDM_calc_edges(struct DerivedMesh *dm); /* reconstitute face triangulation */ -void CDDM_recalc_tesselation(struct DerivedMesh *dm); -void CDDM_recalc_tesselation_ex(struct DerivedMesh *dm, const int do_face_nor_cpy); +void CDDM_recalc_tessellation(struct DerivedMesh *dm); +void CDDM_recalc_tessellation_ex(struct DerivedMesh *dm, const int do_face_nor_cpy); /* lowers the number of vertices/edges/faces in a CDDerivedMesh * the layer data stays the same size diff --git a/source/blender/blenkernel/BKE_idcode.h b/source/blender/blenkernel/BKE_idcode.h index d8e77abc989..2a01ef3afdb 100644 --- a/source/blender/blenkernel/BKE_idcode.h +++ b/source/blender/blenkernel/BKE_idcode.h @@ -35,8 +35,8 @@ /** * Convert an idcode into a name. * - * @param code The code to convert. - * @return A static string representing the name of + * \param code The code to convert. + * \return A static string representing the name of * the code. */ const char *BKE_idcode_to_name(int code); @@ -44,8 +44,8 @@ const char *BKE_idcode_to_name(int code); /** * Convert an idcode into a name (plural). * - * @param code The code to convert. - * @return A static string representing the name of + * \param code The code to convert. + * \return A static string representing the name of * the code. */ const char *BKE_idcode_to_name_plural(int code); @@ -53,32 +53,32 @@ const char *BKE_idcode_to_name_plural(int code); /** * Convert a name into an idcode (ie. ID_SCE) * - * @param name The name to convert. - * @return The code for the name, or 0 if invalid. + * \param name The name to convert. + * \return The code for the name, or 0 if invalid. */ int BKE_idcode_from_name(const char *name); /** * Return non-zero when an ID type is linkable. * - * @param code The code to check. - * @return Boolean, 0 when non linkable. + * \param code The code to check. + * \return Boolean, 0 when non linkable. */ int BKE_idcode_is_linkable(int code); /** * Return if the ID code is a valid ID code. * - * @param code The code to check. - * @return Boolean, 0 when invalid. + * \param code The code to check. + * \return Boolean, 0 when invalid. */ int BKE_idcode_is_valid(int code); /** * Return an ID code and steps the index forward 1. * - * @param index start as 0. - * @return the code, 0 when all codes have been returned. + * \param index start as 0. + * \return the code, 0 when all codes have been returned. */ int BKE_idcode_iter_step(int *index); diff --git a/source/blender/blenkernel/BKE_mesh.h b/source/blender/blenkernel/BKE_mesh.h index 6c6153523b7..4a37252e3fb 100644 --- a/source/blender/blenkernel/BKE_mesh.h +++ b/source/blender/blenkernel/BKE_mesh.h @@ -64,19 +64,19 @@ extern "C" { struct BMesh *BKE_mesh_to_bmesh(struct Mesh *me, struct Object *ob); /* - * this function recreates a tesselation. - * returns number of tesselation faces. + * this function recreates a tessellation. + * returns number of tessellation faces. * - * use_poly_origindex sets whether or not the tesselation faces' origindex + * use_poly_origindex sets whether or not the tessellation faces' origindex * layer should point to original poly indices or real poly indices. * - * use_face_origindex sets the tesselation faces' origindex layer - * to point to the tesselation faces themselves, not the polys. + * use_face_origindex sets the tessellation faces' origindex layer + * to point to the tessellation faces themselves, not the polys. * * if both of the above are 0, it'll use the indices of the mpolys of the MPoly * data in pdata, and ignore the origindex layer altogether. */ -int mesh_recalcTesselation(struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata, +int mesh_recalcTessellation(struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata, struct MVert *mvert, int totface, int totloop, int totpoly, const int do_face_normals); @@ -198,7 +198,7 @@ typedef struct UvMapVert { /* UvElement stores per uv information so that we can quickly access information for a uv. * it is actually an improved UvMapVert, including an island and a direct pointer to the face - * to avoid initialising face arrays */ + * to avoid initializing face arrays */ typedef struct UvElement { /* Next UvElement corresponding to same vertex */ struct UvElement *next; diff --git a/source/blender/blenkernel/BKE_tessmesh.h b/source/blender/blenkernel/BKE_tessmesh.h index ae2882b1712..d935c932387 100644 --- a/source/blender/blenkernel/BKE_tessmesh.h +++ b/source/blender/blenkernel/BKE_tessmesh.h @@ -40,7 +40,7 @@ ok: the EDBM module is for editmode bmesh stuff. in contrast, the /*this structure replaces EditMesh. through this, you get access to both the edit bmesh, - it's tesselation, and various stuff that doesn't belong in the BMesh + it's tessellation, and various stuff that doesn't belong in the BMesh struct itself. the entire derivedmesh and modifier system works with this structure, @@ -52,7 +52,7 @@ typedef struct BMEditMesh { struct BMEditMesh *emcopy; int emcopyusers; - /*we store tesselations as triplets of three loops, + /*we store tessellations as triplets of three loops, which each define a triangle.*/ struct BMLoop *(*looptris)[3]; int tottri; @@ -85,7 +85,7 @@ typedef struct BMEditMesh { * BMESH_TODO, look into having the update elsewhere. */ #define BMESH_EM_UNDO_RECALC_TESSFACE_WORKAROUND -void BMEdit_RecalcTesselation(BMEditMesh *tm); +void BMEdit_RecalcTessellation(BMEditMesh *tm); BMEditMesh *BMEdit_Create(BMesh *bm, int do_tesselate); BMEditMesh *BMEdit_Copy(BMEditMesh *tm); BMEditMesh *BMEdit_FromObject(struct Object *ob); diff --git a/source/blender/blenkernel/intern/DerivedMesh.c b/source/blender/blenkernel/intern/DerivedMesh.c index 9d5b8a3b6a5..0d12785872c 100644 --- a/source/blender/blenkernel/intern/DerivedMesh.c +++ b/source/blender/blenkernel/intern/DerivedMesh.c @@ -360,7 +360,7 @@ void DM_ensure_tessface(DerivedMesh *dm) const int numPolys = dm->getNumPolys(dm); if ( (numTessFaces == 0) && (numPolys != 0)) { - dm->recalcTesselation(dm); + dm->recalcTessellation(dm); if (dm->getNumTessFaces(dm) != 0) { /* printf("info %s: polys -> ngons calculated\n", __func__); */ @@ -1091,9 +1091,9 @@ void DM_update_weight_mcol(Object *ob, DerivedMesh *dm, int const draw_flag, wtcol_v = calc_weightpaint_vert_array(ob, dm, draw_flag, coba); /* Now copy colors in all face verts. */ - /*first add colors to the tesselation faces*/ + /*first add colors to the tessellation faces*/ /* XXX Why update that layer? We have to update WEIGHT_MLOOPCOL anyway, - * and tesselation recreates mface layers from mloop/mpoly ones, so no + * and tessellation recreates mface layers from mloop/mpoly ones, so no * need to fill WEIGHT_MCOL here. */ #if 0 for (i = 0; i < numFaces; i++, mf++, wtcol_f_step += (4 * 4)) { @@ -1661,7 +1661,7 @@ static void mesh_calc_modifiers(Scene *scene, Object *ob, float (*inputVertexCos /* calculating normals can re-calculate tessfaces in some cases */ int num_tessface = finaldm->getNumTessFaces(finaldm); /* --------------------------------------------------------------------- */ - /* First calculate the polygon and vertex normals, re-tesselation + /* First calculate the polygon and vertex normals, re-tessellation * copies these into the tessface's normal layer */ @@ -1673,13 +1673,13 @@ static void mesh_calc_modifiers(Scene *scene, Object *ob, float (*inputVertexCos finaldm->calcNormals(finaldm); #endif - /* Re-tesselation is necessary to push render data (uvs, textures, colors) + /* Re-tessellation is necessary to push render data (uvs, textures, colors) * from loops and polys onto the tessfaces. This may be currently be - * redundantin cases where the render mode doesn't use these inputs, but - * ideally eventually tesselation would happen on-demand, and this is one + * redundant in cases where the render mode doesn't use these inputs, but + * ideally eventually tessellation would happen on-demand, and this is one * of the primary places it would be needed. */ if (num_tessface == 0 && finaldm->getNumTessFaces(finaldm) == 0) { - finaldm->recalcTesselation(finaldm); + finaldm->recalcTessellation(finaldm); } /* Need to watch this, it can cause issues, see bug [#29338] */ /* take care with this block, we really need testing frameworks */ diff --git a/source/blender/blenkernel/intern/anim.c b/source/blender/blenkernel/intern/anim.c index d0733166074..6f3facb6d9d 100644 --- a/source/blender/blenkernel/intern/anim.c +++ b/source/blender/blenkernel/intern/anim.c @@ -318,7 +318,7 @@ static void motionpaths_calc_update_scene(Scene *scene) /* find the last object with the tag * - all those afterwards are assumed to not be relevant for our calculations */ - // optimise further by moving out... + // optimize further by moving out... for (base=scene->base.first; base; base=base->next) { if (base->object->flag & BA_TEMP_TAG) last = base; @@ -416,7 +416,7 @@ void animviz_calc_motionpaths(Scene *scene, ListBase *targets) } if (efra <= sfra) return; - /* optimise the depsgraph for faster updates */ + /* optimize the depsgraph for faster updates */ // TODO: whether this is used should depend on some setting for the level of optimisations used motionpaths_calc_optimise_depsgraph(scene, targets); diff --git a/source/blender/blenkernel/intern/anim_sys.c b/source/blender/blenkernel/intern/anim_sys.c index ec92685b594..ea353fc9073 100644 --- a/source/blender/blenkernel/intern/anim_sys.c +++ b/source/blender/blenkernel/intern/anim_sys.c @@ -1176,7 +1176,7 @@ static short animsys_write_rna_setting (PointerRNA *ptr, char *path, int array_i if (RNA_property_update_check(prop)) { short skip_updates_hack = 0; - /* optimisation hacks: skip property updates for those properties + /* optimization hacks: skip property updates for those properties * for we know that which the updates in RNA were really just for * flushing property editing via UI/Py */ @@ -1676,7 +1676,7 @@ static void nlaevalchan_buffers_accumulate (ListBase *channels, ListBase *tmp_bu { NlaEvalChannel *nec, *necn, *necd; - /* optimise - abort if no channels */ + /* optimize - abort if no channels */ if (tmp_buffer->first == NULL) return; @@ -2288,13 +2288,13 @@ void BKE_animsys_evaluate_all_animation (Main *main, Scene *scene, float ctime) } \ } - /* optimisation: + /* optimization: * when there are no actions, don't go over database and loop over heaps of datablocks, * which should ultimately be empty, since it is not possible for now to have any animation * without some actions, and drivers wouldn't get affected by any state changes * * however, if there are some curves, we will need to make sure that their 'ctime' property gets - * set correctly, so this optimisation must be skipped in that case... + * set correctly, so this optimization must be skipped in that case... */ if ((main->action.first == NULL) && (main->curve.first == NULL)) { if (G.f & G_DEBUG) @@ -2347,7 +2347,7 @@ void BKE_animsys_evaluate_all_animation (Main *main, Scene *scene, float ctime) /* objects */ /* ADT_RECALC_ANIM doesn't need to be supplied here, since object AnimData gets - * this tagged by Depsgraph on framechange. This optimisation means that objects + * this tagged by Depsgraph on framechange. This optimization means that objects * linked from other (not-visible) scenes will not need their data calculated. */ EVAL_ANIM_IDS(main->object.first, 0); diff --git a/source/blender/blenkernel/intern/bvhutils.c b/source/blender/blenkernel/intern/bvhutils.c index f4416b8f5d6..0af3c9c9f02 100644 --- a/source/blender/blenkernel/intern/bvhutils.c +++ b/source/blender/blenkernel/intern/bvhutils.c @@ -595,7 +595,7 @@ BVHTree* bvhtree_from_mesh_faces(BVHTreeFromMesh *data, DerivedMesh *mesh, float /* XXX, for snap only, em & dm are assumed to be aligned, since dm is the em's cage */ - /*Insert BMesh-tesselation triangles into the bvh tree, unless they are hidden + /*Insert BMesh-tessellation triangles into the bvh tree, unless they are hidden and/or selected. Even if the faces themselves are not selected for the snapped transform, having a vertex selected means the face (and thus it's tesselated triangles) will be moving and will not be a good snap targets.*/ diff --git a/source/blender/blenkernel/intern/cdderivedmesh.c b/source/blender/blenkernel/intern/cdderivedmesh.c index 4fafd604e70..50d0f2daab9 100644 --- a/source/blender/blenkernel/intern/cdderivedmesh.c +++ b/source/blender/blenkernel/intern/cdderivedmesh.c @@ -1589,11 +1589,11 @@ static void cdDM_foreachMappedFaceCenter( } -void CDDM_recalc_tesselation_ex(DerivedMesh *dm, const int do_face_nor_cpy) +void CDDM_recalc_tessellation_ex(DerivedMesh *dm, const int do_face_nor_cpy) { CDDerivedMesh *cddm = (CDDerivedMesh*)dm; - dm->numTessFaceData = mesh_recalcTesselation(&dm->faceData, &dm->loopData, &dm->polyData, + dm->numTessFaceData = mesh_recalcTessellation(&dm->faceData, &dm->loopData, &dm->polyData, cddm->mvert, dm->numTessFaceData, dm->numLoopData, dm->numPolyData, do_face_nor_cpy); @@ -1605,14 +1605,14 @@ void CDDM_recalc_tesselation_ex(DerivedMesh *dm, const int do_face_nor_cpy) cddm->mface = CustomData_get_layer(&dm->faceData, CD_MFACE); - /* Tesselation recreated faceData, and the active layer indices need to get re-propagated + /* Tessellation recreated faceData, and the active layer indices need to get re-propagated from loops and polys to faces */ CustomData_bmesh_update_active_layers(&dm->faceData, &dm->polyData, &dm->loopData); } -void CDDM_recalc_tesselation(DerivedMesh *dm) +void CDDM_recalc_tessellation(DerivedMesh *dm) { - CDDM_recalc_tesselation_ex(dm, TRUE); + CDDM_recalc_tessellation_ex(dm, TRUE); } static void cdDM_free_internal(CDDerivedMesh *cddm) @@ -1674,7 +1674,7 @@ static CDDerivedMesh *cdDM_create(const char *desc) dm->getTessFaceDataArray = DM_get_tessface_data_layer; dm->calcNormals = CDDM_calc_normals_mapping; - dm->recalcTesselation = CDDM_recalc_tesselation; + dm->recalcTessellation = CDDM_recalc_tessellation; dm->getVertCos = cdDM_getVertCos; dm->getVertCo = cdDM_getVertCo; @@ -1928,7 +1928,7 @@ DerivedMesh *CDDM_from_BMEditMesh(BMEditMesh *em, Mesh *UNUSED(me), int use_mdis CustomData_merge(&bm->pdata, &dm->polyData, mask, CD_CALLOC, dm->numPolyData); - /*add tesselation mface layers*/ + /*add tessellation mface layers*/ if (use_tessface) { CustomData_from_bmeshpoly(&dm->faceData, &dm->polyData, &dm->loopData, em->tottri); } @@ -2083,7 +2083,7 @@ static DerivedMesh *cddm_copy_ex(DerivedMesh *source, int faces_from_tessfaces) #if 0 /* BMESH_TODO: Find out why this is necessary (or else find a way to remove it). If it is necessary, add a comment explaining why. */ - CDDM_recalc_tesselation((DerivedMesh *)cddm); + CDDM_recalc_tessellation((DerivedMesh *)cddm); #endif return dm; @@ -2190,15 +2190,15 @@ void CDDM_calc_normals_mapping(DerivedMesh *dm) if (dm->numTessFaceData == 0) { - /* No tesselation on this mesh yet, need to calculate one. + /* No tessellation on this mesh yet, need to calculate one. * * Important not to update face normals from polys since it * interfears with assigning the new normal layer in the following code. */ - CDDM_recalc_tesselation_ex(dm, FALSE); + CDDM_recalc_tessellation_ex(dm, FALSE); } else { - /* A tesselation already exists, it should always have a CD_POLYINDEX */ + /* A tessellation already exists, it should always have a CD_POLYINDEX */ BLI_assert(CustomData_has_layer(&dm->faceData, CD_POLYINDEX)); CustomData_free_layers(&dm->faceData, CD_NORMAL, dm->numTessFaceData); } @@ -2269,7 +2269,7 @@ void CDDM_calc_normals_tessface(DerivedMesh *dm) * * this is a really horribly written function. ger. - joeedh * - * note, CDDM_recalc_tesselation has to run on the returned DM if you want to access tessfaces. + * note, CDDM_recalc_tessellation has to run on the returned DM if you want to access tessfaces. */ DerivedMesh *CDDM_merge_verts(DerivedMesh *dm, const int *vtargetmap) { diff --git a/source/blender/blenkernel/intern/constraint.c b/source/blender/blenkernel/intern/constraint.c index 9047f0262cd..c66b8da0dcd 100644 --- a/source/blender/blenkernel/intern/constraint.c +++ b/source/blender/blenkernel/intern/constraint.c @@ -279,7 +279,7 @@ void constraint_mat_convertspace (Object *ob, bPoseChannel *pchan, float mat[][4 /* prevent crashes in these unlikely events */ if (ob==NULL || mat==NULL) return; - /* optimise trick - check if need to do anything */ + /* optimize trick - check if need to do anything */ if (from == to) return; /* are we dealing with pose-channels or objects */ @@ -2148,7 +2148,7 @@ static void actcon_get_tarmat (bConstraint *con, bConstraintOb *cob, bConstraint float s, t; short axis; - /* initialise return matrix */ + /* initialize return matrix */ unit_m4(ct->matrix); /* get the transform matrix of the target */ @@ -4294,7 +4294,7 @@ static void constraints_init_typeinfo (void) */ bConstraintTypeInfo *get_constraint_typeinfo (int type) { - /* initialise the type-info list? */ + /* initialize the type-info list? */ if (CTI_INIT) { constraints_init_typeinfo(); CTI_INIT = 0; @@ -4412,7 +4412,7 @@ static bConstraint *add_new_constraint_internal (const char *name, short type) /* Determine a basic name, and info */ if (cti) { - /* initialise constraint data */ + /* initialize constraint data */ con->data = MEM_callocN(cti->size, cti->structName); /* only constraints that change any settings need this */ @@ -4757,7 +4757,7 @@ void get_constraint_targets_for_solving (bConstraint *con, bConstraintOb *cob, L cti->get_constraint_targets(con, targets); /* set matrices - * - calculate if possible, otherwise just initialise as identity matrix + * - calculate if possible, otherwise just initialize as identity matrix */ if (cti->get_target_matrix) { for (ct= targets->first; ct; ct= ct->next) diff --git a/source/blender/blenkernel/intern/displist.c b/source/blender/blenkernel/intern/displist.c index ea84f73b27f..6383f7b9040 100644 --- a/source/blender/blenkernel/intern/displist.c +++ b/source/blender/blenkernel/intern/displist.c @@ -709,7 +709,7 @@ static ModifierData *curve_get_tesselate_point(Scene *scene, Object *ob, int for if (ELEM3(md->type, eModifierType_Hook, eModifierType_Softbody, eModifierType_MeshDeform)) { preTesselatePoint = md; - /* this modifiers are moving point of tesselation automatically + /* this modifiers are moving point of tessellation automatically (some of them even can't be applied on tesselated curve), set flag for incformation button in modifier's header */ md->mode |= eModifierMode_ApplyOnSpline; @@ -1168,7 +1168,7 @@ void makeDispListSurf(Scene *scene, Object *ob, ListBase *dispbase, } /* make copy of 'undeformed" displist for texture space calculation - actually, it's not totally undeformed -- pre-tesselation modifiers are + actually, it's not totally undeformed -- pre-tessellation modifiers are already applied, thats how it worked for years, so keep for compatibility (sergey) */ copy_displist(&cu->disp, dispbase); @@ -1394,7 +1394,7 @@ static void do_makeDispListCurveTypes(Scene *scene, Object *ob, ListBase *dispba if(cu->flag & CU_PATH) calc_curvepath(ob); /* make copy of 'undeformed" displist for texture space calculation - actually, it's not totally undeformed -- pre-tesselation modifiers are + actually, it's not totally undeformed -- pre-tessellation modifiers are already applied, thats how it worked for years, so keep for compatibility (sergey) */ copy_displist(&cu->disp, dispbase); diff --git a/source/blender/blenkernel/intern/editderivedmesh.c b/source/blender/blenkernel/intern/editderivedmesh.c index f0fb5cc64b4..139f7d55438 100644 --- a/source/blender/blenkernel/intern/editderivedmesh.c +++ b/source/blender/blenkernel/intern/editderivedmesh.c @@ -75,7 +75,7 @@ BMEditMesh *BMEdit_Create(BMesh *bm, int do_tesselate) tm->bm = bm; if (do_tesselate) { - BMEdit_RecalcTesselation(tm); + BMEdit_RecalcTessellation(tm); } return tm; @@ -90,12 +90,12 @@ BMEditMesh *BMEdit_Copy(BMEditMesh *tm) tm2->bm = BM_mesh_copy(tm->bm); - /*The tesselation is NOT calculated on the copy here, + /*The tessellation is NOT calculated on the copy here, because currently all the callers of this function use it to make a backup copy of the BMEditMesh to restore it in the case of errors in an operation. For perf reasons, in that case it makes more sense to do the - tesselation only when/if that copy ends up getting + tessellation only when/if that copy ends up getting used.*/ tm2->looptris = NULL; @@ -106,7 +106,7 @@ BMEditMesh *BMEdit_Copy(BMEditMesh *tm) return tm2; } -static void BMEdit_RecalcTesselation_intern(BMEditMesh *tm) +static void BMEdit_RecalcTessellation_intern(BMEditMesh *tm) { /* use this to avoid locking pthread for _every_ polygon * and calling the fill function */ @@ -245,21 +245,21 @@ static void BMEdit_RecalcTesselation_intern(BMEditMesh *tm) } -void BMEdit_RecalcTesselation(BMEditMesh *em) +void BMEdit_RecalcTessellation(BMEditMesh *em) { - BMEdit_RecalcTesselation_intern(em); + BMEdit_RecalcTessellation_intern(em); /* commented because editbmesh_build_data() ensures we get tessfaces */ #if 0 if (em->derivedFinal && em->derivedFinal == em->derivedCage) { - if (em->derivedFinal->recalcTesselation) - em->derivedFinal->recalcTesselation(em->derivedFinal); + if (em->derivedFinal->recalcTessellation) + em->derivedFinal->recalcTessellation(em->derivedFinal); } else if (em->derivedFinal) { - if (em->derivedCage->recalcTesselation) - em->derivedCage->recalcTesselation(em->derivedCage); - if (em->derivedFinal->recalcTesselation) - em->derivedFinal->recalcTesselation(em->derivedFinal); + if (em->derivedCage->recalcTessellation) + em->derivedCage->recalcTessellation(em->derivedCage); + if (em->derivedFinal->recalcTessellation) + em->derivedFinal->recalcTessellation(em->derivedFinal); } #endif } @@ -314,13 +314,13 @@ void BMEdit_Free(BMEditMesh *em) ok, basic design: the bmesh derivedmesh exposes the mesh as triangles. it stores pointers -to three loops per triangle. the derivedmesh stores a cache of tesselations +to three loops per triangle. the derivedmesh stores a cache of tessellations for each face. this cache will smartly update as needed (though at first it'll simply be more brute force). keeping track of face/edge counts may be a small problbm. this won't be the most efficient thing, considering that internal edges and -faces of tesselations are exposed. looking up an edge by index in particular +faces of tessellations are exposed. looking up an edge by index in particular is likely to be a little slow. */ @@ -345,7 +345,7 @@ static void emDM_calcNormals(DerivedMesh *UNUSED(dm)) BMVerts and BMFaces */ } -static void emDM_recalcTesselation(DerivedMesh *UNUSED(dm)) +static void emDM_recalcTessellation(DerivedMesh *UNUSED(dm)) { /* do nothing */ } @@ -1635,7 +1635,7 @@ DerivedMesh *getEditDerivedBMesh( bmdm->dm.getTessFaceDataArray = emDM_getTessFaceDataArray; bmdm->dm.calcNormals = emDM_calcNormals; - bmdm->dm.recalcTesselation = emDM_recalcTesselation; + bmdm->dm.recalcTessellation = emDM_recalcTessellation; bmdm->dm.foreachMappedVert = emDM_foreachMappedVert; bmdm->dm.foreachMappedEdge = emDM_foreachMappedEdge; diff --git a/source/blender/blenkernel/intern/fcurve.c b/source/blender/blenkernel/intern/fcurve.c index fa20db0fe72..1c6c229d8fc 100644 --- a/source/blender/blenkernel/intern/fcurve.c +++ b/source/blender/blenkernel/intern/fcurve.c @@ -362,7 +362,7 @@ int binarysearch_bezt_index (BezTriple array[], float frame, int arraylen, short int start=0, end=arraylen; int loopbreaker= 0, maxloop= arraylen * 2; - /* initialise replace-flag first */ + /* initialize replace-flag first */ *replace= 0; /* sneaky optimisations (don't go through searching process if...): diff --git a/source/blender/blenkernel/intern/fmodifier.c b/source/blender/blenkernel/intern/fmodifier.c index d1edd2c9d0f..19b036d9ccf 100644 --- a/source/blender/blenkernel/intern/fmodifier.c +++ b/source/blender/blenkernel/intern/fmodifier.c @@ -957,7 +957,7 @@ static void fmods_init_typeinfo (void) */ FModifierTypeInfo *get_fmodifier_typeinfo (int type) { - /* initialise the type-info list? */ + /* initialize the type-info list? */ if (FMI_INIT) { fmods_init_typeinfo(); FMI_INIT = 0; @@ -1243,7 +1243,7 @@ static float eval_fmodifier_influence (FModifier *fcm, float evaltime) } /* evaluate time modifications imposed by some F-Curve Modifiers - * - this step acts as an optimisation to prevent the F-Curve stack being evaluated + * - this step acts as an optimization to prevent the F-Curve stack being evaluated * several times by modifiers requesting the time be modified, as the final result * would have required using the modified time * - modifiers only ever receive the unmodified time, as subsequent modifiers should be diff --git a/source/blender/blenkernel/intern/mesh.c b/source/blender/blenkernel/intern/mesh.c index 33ef226f411..23cda362f74 100644 --- a/source/blender/blenkernel/intern/mesh.c +++ b/source/blender/blenkernel/intern/mesh.c @@ -303,7 +303,7 @@ const char *mesh_cmp(Mesh *me1, Mesh *me2, float thresh) return NULL; } -static void mesh_ensure_tesselation_customdata(Mesh *me) +static void mesh_ensure_tessellation_customdata(Mesh *me) { const int tottex_original = CustomData_number_of_layers(&me->pdata, CD_MTEXPOLY); const int totcol_original = CustomData_number_of_layers(&me->ldata, CD_MLOOPCOL); @@ -322,7 +322,7 @@ static void mesh_ensure_tesselation_customdata(Mesh *me) * first time from bmesh, rather then giving a warning about this we could be smarter * and check if there was any data to begin with, for now just print the warning with * some info to help troubleshoot whats going on - campbell */ - printf("%s: warning! Tesselation uvs or vcol data got out of sync, " + printf("%s: warning! Tessellation uvs or vcol data got out of sync, " "had to reset!\n CD_MTFACE: %d != CD_MTEXPOLY: %d || CD_MCOL: %d != CD_MLOOPCOL: %d\n", __func__, tottex_tessface, tottex_original, totcol_tessface, totcol_original); } @@ -340,7 +340,7 @@ static void mesh_update_linked_customdata(Mesh *me, const short do_ensure_tess_c BMEdit_UpdateLinkedCustomData(me->edit_btmesh); if (do_ensure_tess_cd) { - mesh_ensure_tesselation_customdata(me); + mesh_ensure_tessellation_customdata(me); } CustomData_bmesh_update_active_layers(&me->fdata, &me->pdata, &me->ldata); @@ -1688,7 +1688,7 @@ void mesh_calc_normals_mapping_ex(MVert *mverts, int numVerts, } else { /* eek, we're not corresponding to polys */ - printf("error in mesh_calc_normals; tesselation face indices are incorrect. normals may look bad.\n"); + printf("error in mesh_calc_normals; tessellation face indices are incorrect. normals may look bad.\n"); } } } @@ -2185,10 +2185,10 @@ void mesh_loops_to_mface_corners(CustomData *fdata, CustomData *ldata, } /* - this function recreates a tesselation. - returns number of tesselation faces. + this function recreates a tessellation. + returns number of tessellation faces. */ -int mesh_recalcTesselation(CustomData *fdata, +int mesh_recalcTessellation(CustomData *fdata, CustomData *ldata, CustomData *pdata, MVert *mvert, int totface, int UNUSED(totloop), int totpoly, @@ -2467,8 +2467,8 @@ int mesh_recalcTesselation(CustomData *fdata, #ifdef USE_BMESH_SAVE_AS_COMPAT /* - * this function recreates a tesselation. - * returns number of tesselation faces. + * this function recreates a tessellation. + * returns number of tessellation faces. */ int mesh_mpoly_to_mface(struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata, int totface, int UNUSED(totloop), int totpoly) @@ -2946,7 +2946,7 @@ void BKE_mesh_ensure_navmesh(Mesh *me) void BKE_mesh_tessface_calc(Mesh *mesh) { - mesh->totface = mesh_recalcTesselation(&mesh->fdata, &mesh->ldata, &mesh->pdata, + mesh->totface = mesh_recalcTessellation(&mesh->fdata, &mesh->ldata, &mesh->pdata, mesh->mvert, mesh->totface, mesh->totloop, mesh->totpoly, /* calc normals right after, dont copy from polys here */ diff --git a/source/blender/blenkernel/intern/modifiers_bmesh.c b/source/blender/blenkernel/intern/modifiers_bmesh.c index fb7e18e295e..da8af1357ab 100644 --- a/source/blender/blenkernel/intern/modifiers_bmesh.c +++ b/source/blender/blenkernel/intern/modifiers_bmesh.c @@ -157,7 +157,7 @@ BMEditMesh *DM_to_editbmesh(Object *ob, DerivedMesh *dm, BMEditMesh *existing, i } else { if (do_tesselate) { - BMEdit_RecalcTesselation(em); + BMEdit_RecalcTessellation(em); } } diff --git a/source/blender/blenkernel/intern/nla.c b/source/blender/blenkernel/intern/nla.c index e5400cf13f2..814f0715d11 100644 --- a/source/blender/blenkernel/intern/nla.c +++ b/source/blender/blenkernel/intern/nla.c @@ -841,7 +841,7 @@ void BKE_nlameta_flush_transforms (NlaStrip *mstrip) oEnd= ((NlaStrip *)mstrip->strips.last)->end; offset= mstrip->start - oStart; - /* optimisation: + /* optimization: * don't flush if nothing changed yet * TODO: maybe we need a flag to say always flush? */ @@ -1018,7 +1018,7 @@ short BKE_nlatrack_get_bounds (NlaTrack *nlt, float bounds[2]) { NlaStrip *strip; - /* initialise bounds */ + /* initialize bounds */ if (bounds) bounds[0] = bounds[1] = 0.0f; else diff --git a/source/blender/blenkernel/intern/shrinkwrap.c b/source/blender/blenkernel/intern/shrinkwrap.c index dde3aeba75d..efc3477298c 100644 --- a/source/blender/blenkernel/intern/shrinkwrap.c +++ b/source/blender/blenkernel/intern/shrinkwrap.c @@ -287,7 +287,7 @@ static void shrinkwrap_calc_normal_projection(ShrinkwrapCalcData *calc) BVHTreeRayHit hit; BVHTreeFromMesh treeData= NULL_BVHTreeFromMesh; - //auxiliar target + //auxiliary target DerivedMesh *auxMesh = NULL; BVHTreeFromMesh auxData = NULL_BVHTreeFromMesh; SpaceTransform local2aux; @@ -306,7 +306,7 @@ static void shrinkwrap_calc_normal_projection(ShrinkwrapCalcData *calc) else { //The code supports any axis that is a combination of X,Y,Z - //altought currently UI only allows to set the 3 different axis + //although currently UI only allows to set the 3 different axis if(calc->smd->projAxis & MOD_SHRINKWRAP_PROJECT_OVER_X_AXIS) proj_axis[0] = 1.0f; if(calc->smd->projAxis & MOD_SHRINKWRAP_PROJECT_OVER_Y_AXIS) proj_axis[1] = 1.0f; if(calc->smd->projAxis & MOD_SHRINKWRAP_PROJECT_OVER_Z_AXIS) proj_axis[2] = 1.0f; diff --git a/source/blender/blenkernel/intern/softbody.c b/source/blender/blenkernel/intern/softbody.c index c4ea41f41b3..4f48fb0270f 100644 --- a/source/blender/blenkernel/intern/softbody.c +++ b/source/blender/blenkernel/intern/softbody.c @@ -860,7 +860,7 @@ static void renew_softbody(Scene *scene, Object *ob, int totpoint, int totspring if (totspring) sb->bspring= MEM_mallocN( totspring*sizeof(BodySpring), "bodyspring"); - /* initialise BodyPoint array */ + /* initialize BodyPoint array */ for (i=0; i<totpoint; i++) { BodyPoint *bp = &sb->bpoint[i]; diff --git a/source/blender/blenkernel/intern/subsurf_ccg.c b/source/blender/blenkernel/intern/subsurf_ccg.c index 09056654e09..7f67bb27bf6 100644 --- a/source/blender/blenkernel/intern/subsurf_ccg.c +++ b/source/blender/blenkernel/intern/subsurf_ccg.c @@ -2858,7 +2858,7 @@ static struct PBVH *ccgDM_getPBVH(Object *ob, DerivedMesh *dm) return ccgdm->pbvh; } -static void ccgDM_recalcTesselation(DerivedMesh *UNUSED(dm)) +static void ccgDM_recalcTessellation(DerivedMesh *UNUSED(dm)) { /* Nothing to do: CCG handles creating its own tessfaces */ } @@ -2967,7 +2967,7 @@ static CCGDerivedMesh *getCCGDerivedMesh(CCGSubSurf *ss, ccgdm->dm.copyTessFaceArray = ccgDM_copyFinalFaceArray; ccgdm->dm.calcNormals = ccgDM_calcNormals; - ccgdm->dm.recalcTesselation = ccgDM_recalcTesselation; + ccgdm->dm.recalcTessellation = ccgDM_recalcTessellation; ccgdm->dm.getVertCos = ccgdm_getVertCos; ccgdm->dm.foreachMappedVert = ccgDM_foreachMappedVert; diff --git a/source/blender/blenlib/BLI_dlrbTree.h b/source/blender/blenlib/BLI_dlrbTree.h index 9cb5686131e..e8765e699c8 100644 --- a/source/blender/blenlib/BLI_dlrbTree.h +++ b/source/blender/blenlib/BLI_dlrbTree.h @@ -97,7 +97,7 @@ typedef void (*DLRBT_NUpdate_FP)(void *node, void *data); /* ADT Management ------------------------------- */ -/* Create a new tree, and initialise as necessary */ +/* Create a new tree, and initialize as necessary */ DLRBT_Tree *BLI_dlrbTree_new(void); /* Initialises some given trees */ diff --git a/source/blender/blenlib/BLI_dynstr.h b/source/blender/blenlib/BLI_dynstr.h index 6b499c3bbcf..e6a2bb45a68 100644 --- a/source/blender/blenlib/BLI_dynstr.h +++ b/source/blender/blenlib/BLI_dynstr.h @@ -48,32 +48,32 @@ typedef struct DynStr DynStr; /** * Create a new DynStr. * - * @return Pointer to a new DynStr. + * \return Pointer to a new DynStr. */ DynStr* BLI_dynstr_new (void); /** * Append a c-string to a DynStr. * - * @param ds The DynStr to append to. - * @param cstr The c-string to append. + * \param ds The DynStr to append to. + * \param cstr The c-string to append. */ void BLI_dynstr_append (DynStr *ds, const char *cstr); /** * Append a length clamped c-string to a DynStr. * - * @param ds The DynStr to append to. - * @param cstr The c-string to append. - * @param len The maximum length of the c-string to copy. + * \param ds The DynStr to append to. + * \param cstr The c-string to append. + * \param len The maximum length of the c-string to copy. */ void BLI_dynstr_nappend (DynStr *ds, const char *cstr, int len); /** * Append a c-string to a DynStr, but with formatting like printf. * - * @param ds The DynStr to append to. - * @param format The printf format string to use. + * \param ds The DynStr to append to. + * \param format The printf format string to use. */ void BLI_dynstr_appendf (DynStr *ds, const char *format, ...) #ifdef __GNUC__ @@ -85,8 +85,8 @@ void BLI_dynstr_vappendf (DynStr *ds, const char *format, va_list args); /** * Find the length of a DynStr. * - * @param ds The DynStr of interest. - * @return The length of @a ds. + * \param ds The DynStr of interest. + * \return The length of \a ds. */ int BLI_dynstr_get_len (DynStr *ds); @@ -95,8 +95,8 @@ int BLI_dynstr_get_len (DynStr *ds); * <i> The returned c-string should be free'd * using MEM_freeN. </i> * - * @param ds The DynStr of interest. - * @return The contents of @a ds as a c-string. + * \param ds The DynStr of interest. + * \return The contents of \a ds as a c-string. */ char* BLI_dynstr_get_cstring (DynStr *ds); @@ -105,16 +105,16 @@ char* BLI_dynstr_get_cstring (DynStr *ds); * <i> The str argument must be allocated to be at * least the size of BLI_dynstr_get_len(ds) + 1. </i> * - * @param ds The DynStr of interest. - * @param str The string to fill. - * @return The contents of @a ds as a c-string. + * \param ds The DynStr of interest. + * \param str The string to fill. + * \return The contents of \a ds as a c-string. */ void BLI_dynstr_get_cstring_ex (DynStr *ds, char *str); /** * Free the DynStr * - * @param ds The DynStr to free. + * \param ds The DynStr to free. */ void BLI_dynstr_free (DynStr *ds); diff --git a/source/blender/blenlib/BLI_ghash.h b/source/blender/blenlib/BLI_ghash.h index ccad3250a5f..457f098bff7 100644 --- a/source/blender/blenlib/BLI_ghash.h +++ b/source/blender/blenlib/BLI_ghash.h @@ -80,8 +80,8 @@ int BLI_ghash_size (GHash *gh); * while the iterator is in use, and the iterator will step exactly * BLI_ghash_size(gh) times before becoming done. * - * @param gh The GHash to iterate over. - * @return Pointer to a new DynStr. + * \param gh The GHash to iterate over. + * \return Pointer to a new DynStr. */ GHashIterator* BLI_ghashIterator_new (GHash *gh); /** @@ -89,45 +89,45 @@ GHashIterator* BLI_ghashIterator_new (GHash *gh); * be mutated while the iterator is in use, and the iterator will * step exactly BLI_ghash_size(gh) times before becoming done. * - * @param ghi The GHashIterator to initialize. - * @param gh The GHash to iterate over. + * \param ghi The GHashIterator to initialize. + * \param gh The GHash to iterate over. */ void BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh); /** * Free a GHashIterator. * - * @param ghi The iterator to free. + * \param ghi The iterator to free. */ void BLI_ghashIterator_free (GHashIterator *ghi); /** * Retrieve the key from an iterator. * - * @param ghi The iterator. - * @return The key at the current index, or NULL if the + * \param ghi The iterator. + * \return The key at the current index, or NULL if the * iterator is done. */ void* BLI_ghashIterator_getKey (GHashIterator *ghi); /** * Retrieve the value from an iterator. * - * @param ghi The iterator. - * @return The value at the current index, or NULL if the + * \param ghi The iterator. + * \return The value at the current index, or NULL if the * iterator is done. */ void* BLI_ghashIterator_getValue (GHashIterator *ghi); /** * Steps the iterator to the next index. * - * @param ghi The iterator. + * \param ghi The iterator. */ void BLI_ghashIterator_step (GHashIterator *ghi); /** * Determine if an iterator is done (has reached the end of * the hash table). * - * @param ghi The iterator. - * @return True if done, False otherwise. + * \param ghi The iterator. + * \return True if done, False otherwise. */ int BLI_ghashIterator_isDone (GHashIterator *ghi); diff --git a/source/blender/blenlib/BLI_graph.h b/source/blender/blenlib/BLI_graph.h index effa2c3bc03..52613f9869f 100644 --- a/source/blender/blenlib/BLI_graph.h +++ b/source/blender/blenlib/BLI_graph.h @@ -177,7 +177,7 @@ void BLI_mirrorAlongAxis(float v[3], float center[3], float axis[3]); /* BArc symmetry flags * - * axial symetry sides */ + * axial symmetry sides */ #define SYM_SIDE_POSITIVE 1 #define SYM_SIDE_NEGATIVE 2 /* Anything higher is the order in radial symmetry */ diff --git a/source/blender/blenlib/BLI_gsqueue.h b/source/blender/blenlib/BLI_gsqueue.h index 53fdb5a541a..0265cf9b639 100644 --- a/source/blender/blenlib/BLI_gsqueue.h +++ b/source/blender/blenlib/BLI_gsqueue.h @@ -39,8 +39,8 @@ typedef struct _GSQueue GSQueue; /** * Create a new GSQueue. * - * @param elem_size The size of the structures in the queue. - * @retval The new queue + * \param elem_size The size of the structures in the queue. + * \retval The new queue */ GSQueue* BLI_gsqueue_new (int elem_size); @@ -58,7 +58,7 @@ int BLI_gsqueue_size(GSQueue *gq); * Access the item at the head of the queue * without removing it. * - * @param item_r A pointer to an appropriatly + * \param item_r A pointer to an appropriatly * sized structure (the size passed to BLI_gsqueue_new) */ void BLI_gsqueue_peek (GSQueue *gq, void *item_r); @@ -67,7 +67,7 @@ void BLI_gsqueue_peek (GSQueue *gq, void *item_r); * Access the item at the head of the queue * and remove it. * - * @param item_r A pointer to an appropriatly + * \param item_r A pointer to an appropriatly * sized structure (the size passed to BLI_gsqueue_new). * Can be NULL if desired. */ @@ -76,7 +76,7 @@ void BLI_gsqueue_pop (GSQueue *gq, void *item_r); /** * Push an element onto the tail of the queue. * - * @param item A pointer to an appropriatly + * \param item A pointer to an appropriatly * sized structure (the size passed to BLI_gsqueue_new). */ void BLI_gsqueue_push (GSQueue *gq, void *item); @@ -85,7 +85,7 @@ void BLI_gsqueue_push (GSQueue *gq, void *item); * Push an element back onto the head of the queue (so * it would be returned from the next call to BLI_gsqueue_pop). * - * @param item A pointer to an appropriatly + * \param item A pointer to an appropriatly * sized structure (the size passed to BLI_gsqueue_new). */ void BLI_gsqueue_pushback (GSQueue *gq, void *item); diff --git a/source/blender/blenlib/BLI_math_geom.h b/source/blender/blenlib/BLI_math_geom.h index b46f79fb2e6..2a5543b10ed 100644 --- a/source/blender/blenlib/BLI_math_geom.h +++ b/source/blender/blenlib/BLI_math_geom.h @@ -111,12 +111,12 @@ int isect_ray_plane_v3(const float p1[3], const float d[3], /** * Intersect line/plane, optionally treat line as directional (like a ray) with the no_flip argument. - * @param out The intersection point. - * @param l1 The first point of the line. - * @param l2 The second point of the line. - * @param plane_co A point on the plane to intersect with. - * @param plane_no The direction of the plane (does not need to be normalized). - * @param no_flip When true, the intersection point will always be from l1 to l2, even if this is not on the plane. + * \param out The intersection point. + * \param l1 The first point of the line. + * \param l2 The second point of the line. + * \param plane_co A point on the plane to intersect with. + * \param plane_no The direction of the plane (does not need to be normalized). + * \param no_flip When true, the intersection point will always be from l1 to l2, even if this is not on the plane. */ int isect_line_plane_v3(float out[3], const float l1[3], const float l2[3], const float plane_co[3], const float plane_no[3], const short no_flip); @@ -125,12 +125,12 @@ int isect_line_plane_v3(float out[3], const float l1[3], const float l2[3], * Intersect two planes, return a point on the intersection and a vector * that runs on the direction of the intersection. * Return error code is the same as 'isect_line_line_v3'. - * @param r_isect_co The resulting intersection point. - * @param r_isect_no The resulting vector of the intersection. - * @param plane_a_co The point on the first plane. - * @param plane_a_no The normal of the first plane. - * @param plane_b_co The point on the second plane. - * @param plane_b_no The normal of the second plane. + * \param r_isect_co The resulting intersection point. + * \param r_isect_no The resulting vector of the intersection. + * \param plane_a_co The point on the first plane. + * \param plane_a_no The normal of the first plane. + * \param plane_b_co The point on the second plane. + * \param plane_b_no The normal of the second plane. */ void isect_plane_plane_v3(float r_isect_co[3], float r_isect_no[3], const float plane_a_co[3], const float plane_a_no[3], diff --git a/source/blender/blenlib/BLI_path_util.h b/source/blender/blenlib/BLI_path_util.h index a2d432b492a..3ee548098ff 100644 --- a/source/blender/blenlib/BLI_path_util.h +++ b/source/blender/blenlib/BLI_path_util.h @@ -131,15 +131,15 @@ int BLI_has_parent(char *path); /** * Blender's path code replacement function. - * Bases @a path strings leading with "//" by the - * directory @a basepath, and replaces instances of - * '#' with the @a framenum. Results are written - * back into @a path. + * Bases \a path strings leading with "//" by the + * directory \a basepath, and replaces instances of + * '#' with the \a framenum. Results are written + * back into \a path. * - * @a path The path to convert - * @a basepath The directory to base relative paths with. - * @a framenum The framenumber to replace the frame code with. - * @retval Returns true if the path was relative (started with "//"). + * \a path The path to convert + * \a basepath The directory to base relative paths with. + * \a framenum The framenumber to replace the frame code with. + * \retval Returns true if the path was relative (started with "//"). */ int BLI_path_abs(char *path, const char *basepath); int BLI_path_frame(char *path, int frame, int digits); @@ -156,12 +156,12 @@ void BLI_path_rel(char *file, const char *relfile); #endif /** - * Change every @a from in @a string into @a to. The - * result will be in @a string + * Change every \a from in \a string into \a to. The + * result will be in \a string * - * @a string The string to work on - * @a from The character to replace - * @a to The character to replace with + * \a string The string to work on + * \a from The character to replace + * \a to The character to replace with */ void BLI_char_switch(char *string, char from, char to); diff --git a/source/blender/blenlib/BLI_rand.h b/source/blender/blenlib/BLI_rand.h index 1749bbcc38a..d4d6563ac99 100644 --- a/source/blender/blenlib/BLI_rand.h +++ b/source/blender/blenlib/BLI_rand.h @@ -68,8 +68,8 @@ double BLI_drand (void); /** Return a pseudo-random number N where 0.0f<=N<1.0f */ float BLI_frand (void); - /** Fills a block of memory starting at @a addr - * and extending @a len bytes with pseudo-random + /** Fills a block of memory starting at \a addr + * and extending \a len bytes with pseudo-random * contents. This routine does not use nor modify * the state of the BLI random number generator. */ diff --git a/source/blender/blenlib/BLI_rect.h b/source/blender/blenlib/BLI_rect.h index 4ff203737a0..d1209524c15 100644 --- a/source/blender/blenlib/BLI_rect.h +++ b/source/blender/blenlib/BLI_rect.h @@ -46,7 +46,7 @@ extern "C" { * rect is one with a zero (or negative) * width or height. * - * @return True if @a rect is empty. + * \return True if \a rect is empty. */ int BLI_rcti_is_empty(struct rcti *rect); int BLI_rctf_is_empty(struct rctf *rect); diff --git a/source/blender/blenlib/BLI_scanfill.h b/source/blender/blenlib/BLI_scanfill.h index 1f0e455fa45..d497ffa4941 100644 --- a/source/blender/blenlib/BLI_scanfill.h +++ b/source/blender/blenlib/BLI_scanfill.h @@ -36,7 +36,7 @@ */ /** - * @attention Defined in scanfill.c + * \attention Defined in scanfill.c */ extern struct ListBase fillvertbase; extern struct ListBase filledgebase; @@ -94,8 +94,8 @@ void BLI_end_edgefill(void); /** * Set a function taking a char* as argument to flag errors. If the * callback is not set, the error is discarded. - * @param f The function to use as callback - * @attention used in creator.c + * \param f The function to use as callback + * \attention used in creator.c */ void BLI_setErrorCallBack(void (*f)(const char*)); @@ -104,8 +104,8 @@ void BLI_setErrorCallBack(void (*f)(const char*)); * in this module. If the function returns true, the execution will * terminate gracefully. If the callback is not set, interruption is * not possible. - * @param f The function to use as callback - * @attention used in creator.c + * \param f The function to use as callback + * \attention used in creator.c */ void BLI_setInterruptCallBack(int (*f)(void)); diff --git a/source/blender/blenlib/BLI_sparsemap.h b/source/blender/blenlib/BLI_sparsemap.h deleted file mode 100644 index 654cafbc200..00000000000 --- a/source/blender/blenlib/BLI_sparsemap.h +++ /dev/null @@ -1,81 +0,0 @@ -#if 0 -/* - * ***** BEGIN GPL LICENSE BLOCK ***** - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software Foundation, - * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - * - * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung - * All rights reserved. - * - * Contributor(s): Joseph Eagar (original author) - * - * ***** END GPL LICENSE BLOCK ***** - */ - -#ifndef __BLI_SPARSEMAP_H__ -#define __BLI_SPARSEMAP_H__ - -/** \file BLI_sparsemap.h - * \ingroup bli - */ - -#include "BLI_math_inline.h" - -typedef struct SparseMap { - int max; - int blocksize; - void **blocks; - int totblock; -} SparseMap; - -MALWAYS_INLINE SparseMap *BLI_sparsemap_new(int blocksize, char *name) -{ - SparseMap *sm = MEM_callocN(sizeof(SparseMap), name); - - sm->blocksize = blocksize; - return sm; -} - -MALWAYS_INLINE void BLI_sparsemap_free(SparseMap *sm) -{ - if (sm->blocks) - MEM_freeN(sm->blocks); - - MEM_freeN(sm); -} - -MALWAYS_INLINE void BLI_sparsemap_set(SparseMap *sm, int index, void *ptr) -{ - if (index >= sm->max || (sm->blocks && !sm->blocks[index/sm->blocksize])) { - int totblock = MAX2((index+1)/sm->blocksize, 2); - void *blocks = MEM_callocN(sizeof(void*)*totblock); - - if (sm->blocks) - memcpy(blocks, sm->blocks, sizeof(void*)*sm->totblock); - sm->totblock = totblock; - MEM_freeN(sm->blocks); - sm->blocks = blocks; - } - - if (!sm->blocks[index/sm->blocksize]) { - sm->blocks[index/sm->blocksize] = MEM_mallocN(sizeof(void*)*sm->blocksize); - } - - sm->blocks[index/sm->blocksize] = ptr; -} - -#endif /* __BLI_SPARSEMAP_H__ */ - -#endif diff --git a/source/blender/blenlib/BLI_string.h b/source/blender/blenlib/BLI_string.h index 0f419920b21..ec36d587d92 100644 --- a/source/blender/blenlib/BLI_string.h +++ b/source/blender/blenlib/BLI_string.h @@ -37,30 +37,30 @@ extern "C" { #endif /** - * Duplicates the cstring @a str into a newly mallocN'd + * Duplicates the cstring \a str into a newly mallocN'd * string and returns it. * - * @param str The string to be duplicated - * @retval Returns the duplicated string + * \param str The string to be duplicated + * \retval Returns the duplicated string */ char *BLI_strdup(const char *str); /** - * Duplicates the first @a len bytes of cstring @a str - * into a newly mallocN'd string and returns it. @a str + * Duplicates the first \a len bytes of cstring \a str + * into a newly mallocN'd string and returns it. \a str * is assumed to be at least len bytes long. * - * @param str The string to be duplicated - * @param len The number of bytes to duplicate - * @retval Returns the duplicated string + * \param str The string to be duplicated + * \param len The number of bytes to duplicate + * \retval Returns the duplicated string */ char *BLI_strdupn(const char *str, const size_t len); /** * Appends the two strings, and returns new mallocN'ed string - * @param str1 first string for copy - * @param str2 second string for append - * @retval Returns dst + * \param str1 first string for copy + * \param str2 second string for append + * \retval Returns dst */ char *BLI_strdupcat(const char *str1, const char *str2); @@ -68,11 +68,11 @@ char *BLI_strdupcat(const char *str1, const char *str2); * Like strncpy but ensures dst is always * '\0' terminated. * - * @param dst Destination for copy - * @param src Source string to copy - * @param maxncpy Maximum number of characters to copy (generally + * \param dst Destination for copy + * \param src Source string to copy + * \param maxncpy Maximum number of characters to copy (generally * the size of dst) - * @retval Returns dst + * \retval Returns dst */ char *BLI_strncpy(char *dst, const char *src, const size_t maxncpy); @@ -88,14 +88,14 @@ char *BLI_strncpy(char *dst, const char *src, const size_t maxncpy); char *BLI_getQuotedStr(const char *str, const char *prefix); /** - * Returns a copy of the cstring @a str into a newly mallocN'd + * Returns a copy of the cstring \a str into a newly mallocN'd * string with all instances of oldText replaced with newText, * and returns it. * - * @param str The string to replace occurrences of oldText in - * @param oldText The text in the string to find and replace - * @param newText The text in the string to find and replace - * @retval Returns the duplicated string + * \param str The string to replace occurrences of oldText in + * \param oldText The text in the string to find and replace + * \param newText The text in the string to find and replace + * \retval Returns the duplicated string */ char *BLI_replacestr(char *str, const char *oldText, const char *newText); @@ -123,7 +123,7 @@ size_t BLI_strescape(char *dst, const char *src, const size_t maxlen); /** * Compare two strings without regard to case. * - * @retval True if the strings are equal, false otherwise. + * \retval True if the strings are equal, false otherwise. */ int BLI_strcaseeq(const char *a, const char *b); diff --git a/source/blender/blenlib/BLI_vfontdata.h b/source/blender/blenlib/BLI_vfontdata.h index 5f7b7c39036..0020ba308af 100644 --- a/source/blender/blenlib/BLI_vfontdata.h +++ b/source/blender/blenlib/BLI_vfontdata.h @@ -70,8 +70,8 @@ struct TmpFont * Construct a new VFontData structure from * Freetype font data in a PackedFile. * - * @param pf The font data. - * @retval A new VFontData structure, or NULL + * \param pf The font data. + * \retval A new VFontData structure, or NULL * if unable to load. */ VFontData* diff --git a/source/blender/blenlib/CMakeLists.txt b/source/blender/blenlib/CMakeLists.txt index 46538a6e0c1..90fd8d15c35 100644 --- a/source/blender/blenlib/CMakeLists.txt +++ b/source/blender/blenlib/CMakeLists.txt @@ -92,7 +92,6 @@ set(SRC BLI_array.h BLI_bitmap.h BLI_smallhash.h - BLI_sparsemap.h BLI_args.h BLI_blenlib.h BLI_boxpack2d.h diff --git a/source/blender/blenlib/PIL_time.h b/source/blender/blenlib/PIL_time.h index cef7ba436bc..7d34d33d686 100644 --- a/source/blender/blenlib/PIL_time.h +++ b/source/blender/blenlib/PIL_time.h @@ -42,14 +42,14 @@ extern "C" { extern /** Return an indication of time, expressed as * seconds since some fixed point. Successive calls - * are guarenteed to generate values greater than or + * are guaranteed to generate values greater than or * equal to the last call. */ double PIL_check_seconds_timer (void); /** * Platform-independent sleep function. - * @param ms Number of milliseconds to sleep + * \param ms Number of milliseconds to sleep */ void PIL_sleep_ms (int ms); diff --git a/source/blender/blenlib/intern/BLI_kdopbvh.c b/source/blender/blenlib/intern/BLI_kdopbvh.c index 9ce58aba5b8..afc8a6a4aa6 100644 --- a/source/blender/blenlib/intern/BLI_kdopbvh.c +++ b/source/blender/blenlib/intern/BLI_kdopbvh.c @@ -656,7 +656,7 @@ static int implicit_leafs_index(BVHBuildHelper *data, int depth, int child_index * Its possible to find the position of the child or the parent with simple maths (multiplication and adittion). This type * of tree is for example used on heaps.. where node N has its childs at indexs N*2 and N*2+1. * - * Altought in this case the tree type is general.. and not know until runtime. + * Although in this case the tree type is general.. and not know until runtime. * tree_type stands for the maximum number of childs that a tree node can have. * All tree types >= 2 are supported. * @@ -721,7 +721,7 @@ static void split_leafs(BVHNode **leafs_array, int *nth, int partitions, int spl * to use multithread building. * * To archieve this is necessary to find how much leafs are accessible from a certain branch, BVHBuildHelper - * implicit_needed_branches and implicit_leafs_index are auxiliar functions to solve that "optimal-split". + * implicit_needed_branches and implicit_leafs_index are auxiliary functions to solve that "optimal-split". */ static void non_recursive_bvh_div_nodes(BVHTree *tree, BVHNode *branches_array, BVHNode **leafs_array, int num_leafs) { diff --git a/source/blender/blenlib/intern/DLRB_tree.c b/source/blender/blenlib/intern/DLRB_tree.c index b7df06bbf24..0e90042a35f 100644 --- a/source/blender/blenlib/intern/DLRB_tree.c +++ b/source/blender/blenlib/intern/DLRB_tree.c @@ -36,7 +36,7 @@ /* *********************************************** */ /* Tree API */ -/* Create a new tree, and initialise as necessary */ +/* Create a new tree, and initialize as necessary */ DLRBT_Tree *BLI_dlrbTree_new (void) { /* just allocate for now */ diff --git a/source/blender/blenlib/intern/fileops.c b/source/blender/blenlib/intern/fileops.c index ad0478060f2..895ae03ab0f 100644 --- a/source/blender/blenlib/intern/fileops.c +++ b/source/blender/blenlib/intern/fileops.c @@ -323,7 +323,7 @@ int BLI_rename(const char *from, const char *to) /* * but the UNIX world is tied to the interface, and the system * timer, and... We implement a callback mechanism. The system will - * have to initialise the callback before the functions will work! + * have to initialize the callback before the functions will work! * */ static char str[12 + (MAXPATHLEN * 2)]; diff --git a/source/blender/blenlib/intern/math_matrix.c b/source/blender/blenlib/intern/math_matrix.c index f1dc65bd066..e07025ccf56 100644 --- a/source/blender/blenlib/intern/math_matrix.c +++ b/source/blender/blenlib/intern/math_matrix.c @@ -1196,7 +1196,7 @@ void loc_eul_size_to_mat4(float mat[4][4], const float loc[3], const float eul[3 { float rmat[3][3], smat[3][3], tmat[3][3]; - /* initialise new matrix */ + /* initialize new matrix */ unit_m4(mat); /* make rotation + scaling part */ @@ -1219,7 +1219,7 @@ void loc_eulO_size_to_mat4(float mat[4][4], const float loc[3], const float eul[ { float rmat[3][3], smat[3][3], tmat[3][3]; - /* initialise new matrix */ + /* initialize new matrix */ unit_m4(mat); /* make rotation + scaling part */ @@ -1243,7 +1243,7 @@ void loc_quat_size_to_mat4(float mat[4][4], const float loc[3], const float quat { float rmat[3][3], smat[3][3], tmat[3][3]; - /* initialise new matrix */ + /* initialize new matrix */ unit_m4(mat); /* make rotation + scaling part */ diff --git a/source/blender/blenlib/intern/path_util.c b/source/blender/blenlib/intern/path_util.c index 084af4be573..ec8e1cf6b82 100644 --- a/source/blender/blenlib/intern/path_util.c +++ b/source/blender/blenlib/intern/path_util.c @@ -694,7 +694,7 @@ int BLI_path_abs(char *path, const char *basepath) BLI_char_switch(base, '\\', '/'); /* Paths starting with // will get the blend file as their base, - * this isnt standard in any os but is uesed in blender all over the place */ + * this isnt standard in any os but is used in blender all over the place */ if (wasrelative) { char *lslash= BLI_last_slash(base); if (lslash) { @@ -1748,9 +1748,9 @@ static int add_win32_extension(char *name) * the name to its 8.3 version to prevent problems with * spaces and stuff. Final result is returned in fullname. * -* @param fullname The full path and full name of the executable +* \param fullname The full path and full name of the executable * (must be FILE_MAX minimum) -* @param name The name of the executable (usually argv[0]) to be checked +* \param name The name of the executable (usually argv[0]) to be checked */ static void bli_where_am_i(char *fullname, const size_t maxlen, const char *name) { @@ -1854,9 +1854,9 @@ const char *BLI_program_dir(void) * * 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 +* \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) { diff --git a/source/blender/blenlib/intern/string_utf8.c b/source/blender/blenlib/intern/string_utf8.c index cf865b5686d..c958648836b 100644 --- a/source/blender/blenlib/intern/string_utf8.c +++ b/source/blender/blenlib/intern/string_utf8.c @@ -369,7 +369,7 @@ unsigned int BLI_str_utf8_as_unicode(const char *p) return result; } -/* varient that increments the length */ +/* variant that increments the length */ unsigned int BLI_str_utf8_as_unicode_and_size(const char *p, size_t *index) { int i, mask = 0, len; @@ -384,7 +384,7 @@ unsigned int BLI_str_utf8_as_unicode_and_size(const char *p, size_t *index) return result; } -/* another varient that steps over the index, +/* another variant that steps over the index, * note, currently this also falls back to latin1 for text drawing. */ unsigned int BLI_str_utf8_as_unicode_step(const char *p, size_t *index) { @@ -433,7 +433,7 @@ unsigned int BLI_str_utf8_as_unicode_step(const char *p, size_t *index) /** * BLI_str_utf8_from_unicode: * @c a Unicode character code - * @param outbuf output buffer, must have at least 6 bytes of space. + * \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. * diff --git a/source/blender/blenloader/BLO_readfile.h b/source/blender/blenloader/BLO_readfile.h index 52d06c36bdf..ffac9a2a88f 100644 --- a/source/blender/blenloader/BLO_readfile.h +++ b/source/blender/blenloader/BLO_readfile.h @@ -78,10 +78,10 @@ typedef struct BlendFileData { * returns NULL and sets a report in the list if * it cannot open the file. * - * @param filepath The path of the file to open. - * @param reports If the return value is NULL, errors + * \param filepath The path of the file to open. + * \param reports If the return value is NULL, errors * indicating the cause of the failure. - * @return The data of the file. + * \return The data of the file. */ BlendFileData* BLO_read_from_file(const char *filepath, struct ReportList *reports); @@ -90,11 +90,11 @@ BlendFileData* BLO_read_from_file(const char *filepath, struct ReportList *repor * returns NULL and sets a report in the list if * it cannot open the file. * - * @param mem The file data. - * @param memsize The length of @a mem. - * @param reports If the return value is NULL, errors + * \param mem The file data. + * \param memsize The length of \a mem. + * \param reports If the return value is NULL, errors * indicating the cause of the failure. - * @return The data of the file. + * \return The data of the file. */ BlendFileData* BLO_read_from_memory(void *mem, int memsize, struct ReportList *reports); @@ -109,7 +109,7 @@ BlendFileData *BLO_read_from_memfile(struct Main *oldmain, const char *filename, * data associated with it (the userdef data, and * the main libblock data). * - * @param bfd The structure to free. + * \param bfd The structure to free. */ void BLO_blendfiledata_free( @@ -118,9 +118,9 @@ BLO_blendfiledata_free( /** * Open a blendhandle from a file path. * - * @param file The file path to open. - * @param reports Report errors in opening the file (can be NULL). - * @return A handle on success, or NULL on failure. + * \param file The file path to open. + * \param reports Report errors in opening the file (can be NULL). + * \return A handle on success, or NULL on failure. */ BlendHandle* BLO_blendhandle_from_file( @@ -130,9 +130,9 @@ BLO_blendhandle_from_file( /** * Open a blendhandle from memory. * - * @param mem The data to load from. - * @param memsize The size of the data. - * @return A handle on success, or NULL on failure. + * \param mem The data to load from. + * \param memsize The size of the data. + * \return A handle on success, or NULL on failure. */ BlendHandle* @@ -145,10 +145,10 @@ BLO_blendhandle_from_memory( * of a certain type (ie. All the scene names in * a file). * - * @param bh The blendhandle to access. - * @param ofblocktype The type of names to get. - * @param tot_names The length of the returned list. - * @return A BLI_linklist of strings. The string links + * \param bh The blendhandle to access. + * \param ofblocktype The type of names to get. + * \param tot_names The length of the returned list. + * \return A BLI_linklist of strings. The string links * should be freed with malloc. */ struct LinkNode* @@ -162,10 +162,10 @@ BLO_blendhandle_get_datablock_names( * of a certain type (ie. All the scene names in * a file). * - * @param bh The blendhandle to access. - * @param ofblocktype The type of names to get. - * @param tot_prev The length of the returned list. - * @return A BLI_linklist of PreviewImage. The PreviewImage links + * \param bh The blendhandle to access. + * \param ofblocktype The type of names to get. + * \param tot_prev The length of the returned list. + * \return A BLI_linklist of PreviewImage. The PreviewImage links * should be freed with malloc. */ struct LinkNode* @@ -179,8 +179,8 @@ BLO_blendhandle_get_previews( * file. (ie. file contains Scene, Mesh, and Lamp * datablocks). * - * @param bh The blendhandle to access. - * @return A BLI_linklist of strings. The string links + * \param bh The blendhandle to access. + * \return A BLI_linklist of strings. The string links * should be freed with malloc. */ struct LinkNode* @@ -191,7 +191,7 @@ BLO_blendhandle_get_linkable_groups( * Close and free a blendhandle. The handle * becomes invalid after this call. * - * @param bh The handle to close. + * \param bh The handle to close. */ void BLO_blendhandle_close( @@ -212,10 +212,10 @@ int BLO_is_a_library(const char *path, char *dir, char *group); /** * Initialize the BlendHandle for appending or linking library data. * - * @param mainvar The current main database eg G.main or CTX_data_main(C). - * @param bh A blender file handle as returned by BLO_blendhandle_from_file or BLO_blendhandle_from_memory. - * @param filepath Used for relative linking, copied to the lib->name - * @return the library Main, to be passed to BLO_library_append_named_part as mainl. + * \param mainvar The current main database eg G.main or CTX_data_main(C). + * \param bh A blender file handle as returned by BLO_blendhandle_from_file or BLO_blendhandle_from_memory. + * \param filepath Used for relative linking, copied to the lib->name + * \return the library Main, to be passed to BLO_library_append_named_part as mainl. */ struct Main* BLO_library_append_begin(struct Main *mainvar, BlendHandle** bh, const char *filepath); @@ -223,11 +223,11 @@ struct Main* BLO_library_append_begin(struct Main *mainvar, BlendHandle** bh, co /** * Link/Append a named datablock from an external blend file. * - * @param mainl The main database to link from (not the active one). - * @param bh The blender file handle. - * @param idname The name of the datablock (without the 2 char ID prefix) - * @param idcode The kind of datablock to link. - * @return the appended ID when found. + * \param mainl The main database to link from (not the active one). + * \param bh The blender file handle. + * \param idname The name of the datablock (without the 2 char ID prefix) + * \param idcode The kind of datablock to link. + * \return the appended ID when found. */ struct ID *BLO_library_append_named_part(struct Main *mainl, BlendHandle** bh, const char *idname, const int idcode); @@ -235,13 +235,13 @@ struct ID *BLO_library_append_named_part(struct Main *mainl, BlendHandle** bh, c * Link/Append a named datablock from an external blend file. * optionally instance the object in the scene when the flags are set. * - * @param C The context, when NULL instancing object in the scene isnt done. - * @param mainl The main database to link from (not the active one). - * @param bh The blender file handle. - * @param idname The name of the datablock (without the 2 char ID prefix) - * @param idcode The kind of datablock to link. - * @param flag Options for linking, used for instancing. - * @return the appended ID when found. + * \param C The context, when NULL instancing object in the scene isnt done. + * \param mainl The main database to link from (not the active one). + * \param bh The blender file handle. + * \param idname The name of the datablock (without the 2 char ID prefix) + * \param idcode The kind of datablock to link. + * \param flag Options for linking, used for instancing. + * \return the appended ID when found. */ struct ID *BLO_library_append_named_part_ex(const struct bContext *C, struct Main *mainl, BlendHandle** bh, const char *idname, const int idcode, const short flag); diff --git a/source/blender/blenloader/intern/readfile.c b/source/blender/blenloader/intern/readfile.c index 36653647fa9..fafddaa544f 100644 --- a/source/blender/blenloader/intern/readfile.c +++ b/source/blender/blenloader/intern/readfile.c @@ -6857,7 +6857,7 @@ static void area_add_header_region(ScrArea *sa, ListBase *lb) else ar->alignment= RGN_ALIGN_TOP; - /* initialise view2d data for header region, to allow panning */ + /* initialize view2d data for header region, to allow panning */ /* is copy from ui_view2d.c */ ar->v2d.keepzoom = (V2D_LOCKZOOM_X|V2D_LOCKZOOM_Y|V2D_LIMITZOOM|V2D_KEEPASPECT); ar->v2d.keepofs = V2D_LOCKOFS_Y; @@ -9868,7 +9868,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) } } - /* correctly initialise constinv matrix */ + /* correctly initialize constinv matrix */ unit_m4(ob->constinv); if (ob->type == OB_ARMATURE) { @@ -9898,7 +9898,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) } } - /* correctly initialise constinv matrix */ + /* correctly initialize constinv matrix */ unit_m4(pchan->constinv); } } @@ -11510,7 +11510,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) { Object *ob; - /* properly initialise hair clothsim data on old files */ + /* properly initialize hair clothsim data on old files */ for(ob = main->object.first; ob; ob = ob->id.next) { ModifierData *md; for(md= ob->modifiers.first; md; md= md->next) { @@ -11619,7 +11619,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) /* anim viz changes */ for (ob= main->object.first; ob; ob= ob->id.next) { - /* initialise object defaults */ + /* initialize object defaults */ animviz_settings_init(&ob->avs); /* if armature, copy settings for pose from armature data @@ -11895,7 +11895,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) if (brush->curve) brush->curve->preset = CURVE_PRESET_SMOOTH; } - /* properly initialise active flag for fluidsim modifiers */ + /* properly initialize active flag for fluidsim modifiers */ for(ob = main->object.first; ob; ob = ob->id.next) { ModifierData *md; for(md= ob->modifiers.first; md; md= md->next) { @@ -12052,7 +12052,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) } } - /* initialise scene active layer */ + /* initialize scene active layer */ for (scene= main->scene.first; scene; scene=scene->id.next) { int i; for(i=0; i<20; i++) { @@ -12422,7 +12422,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) /* redraws flag in SpaceTime has been moved to Screen level */ for (sc = main->screen.first; sc; sc= sc->id.next) { if (sc->redraws_flag == 0) { - /* just initialise to default? */ + /* just initialize to default? */ // XXX: we could also have iterated through areas, and taken them from the first timeline available... sc->redraws_flag = TIME_ALL_3D_WIN|TIME_ALL_ANIM_WIN; } diff --git a/source/blender/blenloader/intern/writefile.c b/source/blender/blenloader/intern/writefile.c index b063a1656ab..10e142f08bb 100644 --- a/source/blender/blenloader/intern/writefile.c +++ b/source/blender/blenloader/intern/writefile.c @@ -231,9 +231,9 @@ static void writedata_free(WriteData *wd) /** * Low level WRITE(2) wrapper that buffers data - * @param adr Pointer to new chunk of data - * @param len Length of new chunk of data - * @warning Talks to other functions with global parameters + * \param adr Pointer to new chunk of data + * \param len Length of new chunk of data + * \warning Talks to other functions with global parameters */ #define MYWRITE_FLUSH NULL @@ -284,10 +284,10 @@ static void mywrite( WriteData *wd, void *adr, int len) /** * BeGiN initializer for mywrite - * @param file File descriptor - * @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 + * \param file File descriptor + * \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 */ static WriteData *bgnwrite(int file, MemFile *compare, MemFile *current) { @@ -305,9 +305,9 @@ static WriteData *bgnwrite(int file, MemFile *compare, MemFile *current) /** * END the mywrite wrapper - * @return 1 if write failed - * @return unknown global variable otherwise - * @warning Talks to other functions with global parameters + * \return 1 if write failed + * \return unknown global variable otherwise + * \warning Talks to other functions with global parameters */ static int endwrite(WriteData *wd) { diff --git a/source/blender/blenpluginapi/documentation.h b/source/blender/blenpluginapi/documentation.h index 45e9ec7f2e4..3e4aa3cd2ed 100644 --- a/source/blender/blenpluginapi/documentation.h +++ b/source/blender/blenpluginapi/documentation.h @@ -27,13 +27,13 @@ * @mainpage plugin API - the access point for texture and sequence * plugins * - * @section about About the plugin API + * \section about About the plugin API * * This API wraps functions that are used by texture and sequence * plugins. They are explicitly wrapped in order to make the * dependencies to the rest of the system clear. * - * @section issues Known issues with the plugin API + * \section issues Known issues with the plugin API * * - It can be difficult at times to get access to the API functions * linked into the final executable. On gcc, the -fpic and -shared @@ -59,7 +59,7 @@ * code. It will be removed as soon as the replacing system is in * place. * - * @section dependencies Dependencies + * \section dependencies Dependencies * * The plugins wraps functions from IMB and BLI. In addition, they * define some useful variables. diff --git a/source/blender/bmesh/bmesh_class.h b/source/blender/bmesh/bmesh_class.h index 1c7717ac5f0..ed4e231edea 100644 --- a/source/blender/bmesh/bmesh_class.h +++ b/source/blender/bmesh/bmesh_class.h @@ -67,7 +67,7 @@ typedef struct BMHeader { * - Unitialized to -1 so we can easily tell its not set. * - Used for edge/vert/face, check BMesh.elem_index_dirty for valid index values, * this is abused by various tools which set it dirty. - * - For loops this is used for sorting during tesselation. */ + * - For loops this is used for sorting during tessellation. */ char htype; /* element geometric type (verts/edges/loops/faces) */ char hflag; /* this would be a CD layer, see below */ diff --git a/source/blender/bmesh/bmesh_error.h b/source/blender/bmesh/bmesh_error.h index 7afddf65a97..b88b1ff890f 100644 --- a/source/blender/bmesh/bmesh_error.h +++ b/source/blender/bmesh/bmesh_error.h @@ -65,7 +65,7 @@ void BMO_error_clear(BMesh *bm); #define BMERR_WALKER_FAILED 4 #define BMERR_DISSOLVEFACES_FAILED 5 #define BMERR_DISSOLVEVERTS_FAILED 6 -#define BMERR_TESSELATION 7 +#define BMERR_TESSELLATION 7 #define BMERR_NONMANIFOLD 8 #define BMERR_INVALID_SELECTION 9 #define BMERR_MESH_ERROR 10 diff --git a/source/blender/bmesh/intern/bmesh_opdefines.c b/source/blender/bmesh/intern/bmesh_opdefines.c index 11236e5a082..37df243d3fc 100644 --- a/source/blender/bmesh/intern/bmesh_opdefines.c +++ b/source/blender/bmesh/intern/bmesh_opdefines.c @@ -536,7 +536,7 @@ static BMOpDefine bmo_bmesh_to_mesh_def = { "bmesh_to_mesh", {{BMO_OP_SLOT_PNT, "mesh"}, //pointer to a mesh structure to fill in {BMO_OP_SLOT_PNT, "object"}, //pointer to an object structure - {BMO_OP_SLOT_BOOL, "notesselation"}, //don't calculate mfaces + {BMO_OP_SLOT_BOOL, "notessellation"}, //don't calculate mfaces {0, /* null-terminating sentine */}}, bmo_bmesh_to_mesh_exec, 0, diff --git a/source/blender/bmesh/intern/bmesh_operators.c b/source/blender/bmesh/intern/bmesh_operators.c index 8374be3ee5b..911c3872161 100644 --- a/source/blender/bmesh/intern/bmesh_operators.c +++ b/source/blender/bmesh/intern/bmesh_operators.c @@ -55,7 +55,7 @@ static const char *bmo_error_messages[] = { "Could not traverse mesh", "Could not dissolve faces", "Could not dissolve vertices", - "Tesselation error", + "Tessellation error", "Can not deal with non-manifold geometry", "Invalid selection", "Internal mesh error", diff --git a/source/blender/bmesh/intern/bmesh_polygon.c b/source/blender/bmesh/intern/bmesh_polygon.c index e34616d5ebc..f6111e75e80 100644 --- a/source/blender/bmesh/intern/bmesh_polygon.c +++ b/source/blender/bmesh/intern/bmesh_polygon.c @@ -25,7 +25,7 @@ * * This file contains code for dealing * with polygons (normal/area calculation, - * tesselation, etc) + * tessellation, etc) * * BMESH_TODO: * - Add in Tesselator frontend that creates diff --git a/source/blender/bmesh/operators/bmo_mesh_conv.c b/source/blender/bmesh/operators/bmo_mesh_conv.c index ddec92e5754..63d8e3b65c3 100644 --- a/source/blender/bmesh/operators/bmo_mesh_conv.c +++ b/source/blender/bmesh/operators/bmo_mesh_conv.c @@ -370,7 +370,7 @@ void bmo_object_load_bmesh_exec(BMesh *bm, BMOperator *op) /* Scene *scene = BMO_slot_ptr_get(op, "scene"); */ Mesh *me = ob->data; - BMO_op_callf(bm, "bmesh_to_mesh mesh=%p object=%p notesselation=%b", me, ob, TRUE); + BMO_op_callf(bm, "bmesh_to_mesh mesh=%p object=%p notessellation=%b", me, ob, TRUE); } @@ -447,7 +447,7 @@ void bmo_bmesh_to_mesh_exec(BMesh *bm, BMOperator *op) BMFace *f; BMIter iter, liter; int i, j, *keyi, ototvert, totloop; - int dotess = !BMO_slot_bool_get(op, "notesselation"); + int dotess = !BMO_slot_bool_get(op, "notessellation"); ototvert = me->totvert; diff --git a/source/blender/bmesh/tools/BME_bevel.c b/source/blender/bmesh/tools/BME_bevel.c index 09e88b77323..04cee14bf21 100644 --- a/source/blender/bmesh/tools/BME_bevel.c +++ b/source/blender/bmesh/tools/BME_bevel.c @@ -1027,7 +1027,7 @@ BMesh *BME_bevel(BMEditMesh *em, float value, int res, int options, int defgrp_i BMO_pop(bm); } - BMEdit_RecalcTesselation(em); + BMEdit_RecalcTessellation(em); /* interactive preview? */ if (rtd) { diff --git a/source/blender/collada/AnimationExporter.cpp b/source/blender/collada/AnimationExporter.cpp index b8bd3ab9fd6..5b1ad604b50 100644 --- a/source/blender/collada/AnimationExporter.cpp +++ b/source/blender/collada/AnimationExporter.cpp @@ -1217,7 +1217,7 @@ void AnimationExporter::sample_and_write_bone_animation(Object *ob_arm, Bone *bo bPoseChannel *pchan = get_pose_channel(ob_arm->pose, bone->name); if (!pchan) return; - //Fill frame array with key frame values framed at @param:transform_type + //Fill frame array with key frame values framed at \param:transform_type switch (transform_type) { case 0: find_rotation_frames(ob_arm, fra, prefix, pchan->rotmode); diff --git a/source/blender/collada/DocumentImporter.cpp b/source/blender/collada/DocumentImporter.cpp index 05b2b3b738d..90c74d8b226 100644 --- a/source/blender/collada/DocumentImporter.cpp +++ b/source/blender/collada/DocumentImporter.cpp @@ -264,7 +264,7 @@ void DocumentImporter::translate_anim_recursive(COLLADAFW::Node *node, COLLADAFW } /** When this method is called, the writer must write the global document asset. - @return The writer should return true, if writing succeeded, false otherwise.*/ + \return The writer should return true, if writing succeeded, false otherwise.*/ bool DocumentImporter::writeGlobalAsset ( const COLLADAFW::FileInfo* asset ) { unit_converter.read_asset(asset); @@ -273,7 +273,7 @@ bool DocumentImporter::writeGlobalAsset ( const COLLADAFW::FileInfo* asset ) } /** When this method is called, the writer must write the scene. - @return The writer should return true, if writing succeeded, false otherwise.*/ + \return The writer should return true, if writing succeeded, false otherwise.*/ bool DocumentImporter::writeScene ( const COLLADAFW::Scene* scene ) { // XXX could store the scene id, but do nothing for now @@ -478,7 +478,7 @@ void DocumentImporter::write_node (COLLADAFW::Node *node, COLLADAFW::Node *paren } /** When this method is called, the writer must write the entire visual scene. - @return The writer should return true, if writing succeeded, false otherwise.*/ + \return The writer should return true, if writing succeeded, false otherwise.*/ bool DocumentImporter::writeVisualScene ( const COLLADAFW::VisualScene* visualScene ) { if(mImportStage!=General) @@ -501,7 +501,7 @@ bool DocumentImporter::writeVisualScene ( const COLLADAFW::VisualScene* visualSc /** When this method is called, the writer must handle all nodes contained in the library nodes. - @return The writer should return true, if writing succeeded, false otherwise.*/ + \return The writer should return true, if writing succeeded, false otherwise.*/ bool DocumentImporter::writeLibraryNodes ( const COLLADAFW::LibraryNodes* libraryNodes ) { if(mImportStage!=General) @@ -519,7 +519,7 @@ bool DocumentImporter::writeLibraryNodes ( const COLLADAFW::LibraryNodes* librar } /** When this method is called, the writer must write the geometry. - @return The writer should return true, if writing succeeded, false otherwise.*/ + \return The writer should return true, if writing succeeded, false otherwise.*/ bool DocumentImporter::writeGeometry ( const COLLADAFW::Geometry* geom ) { if(mImportStage!=General) @@ -529,7 +529,7 @@ bool DocumentImporter::writeGeometry ( const COLLADAFW::Geometry* geom ) } /** When this method is called, the writer must write the material. - @return The writer should return true, if writing succeeded, false otherwise.*/ + \return The writer should return true, if writing succeeded, false otherwise.*/ bool DocumentImporter::writeMaterial( const COLLADAFW::Material* cmat ) { if(mImportStage!=General) @@ -717,7 +717,7 @@ void DocumentImporter::write_profile_COMMON(COLLADAFW::EffectCommon *ef, Materia } /** When this method is called, the writer must write the effect. - @return The writer should return true, if writing succeeded, false otherwise.*/ + \return The writer should return true, if writing succeeded, false otherwise.*/ bool DocumentImporter::writeEffect( const COLLADAFW::Effect* effect ) { @@ -756,7 +756,7 @@ bool DocumentImporter::writeEffect( const COLLADAFW::Effect* effect ) /** When this method is called, the writer must write the camera. - @return The writer should return true, if writing succeeded, false otherwise.*/ + \return The writer should return true, if writing succeeded, false otherwise.*/ bool DocumentImporter::writeCamera( const COLLADAFW::Camera* camera ) { if(mImportStage!=General) @@ -872,7 +872,7 @@ bool DocumentImporter::writeCamera( const COLLADAFW::Camera* camera ) } /** When this method is called, the writer must write the image. - @return The writer should return true, if writing succeeded, false otherwise.*/ + \return The writer should return true, if writing succeeded, false otherwise.*/ bool DocumentImporter::writeImage( const COLLADAFW::Image* image ) { if(mImportStage!=General) @@ -897,7 +897,7 @@ bool DocumentImporter::writeImage( const COLLADAFW::Image* image ) } /** When this method is called, the writer must write the light. - @return The writer should return true, if writing succeeded, false otherwise.*/ + \return The writer should return true, if writing succeeded, false otherwise.*/ bool DocumentImporter::writeLight( const COLLADAFW::Light* light ) { if(mImportStage!=General) @@ -1089,7 +1089,7 @@ bool DocumentImporter::writeAnimationList( const COLLADAFW::AnimationList* anima } /** When this method is called, the writer must write the skin controller data. - @return The writer should return true, if writing succeeded, false otherwise.*/ + \return The writer should return true, if writing succeeded, false otherwise.*/ bool DocumentImporter::writeSkinControllerData( const COLLADAFW::SkinControllerData* skin ) { return armature_importer.write_skin_controller_data(skin); diff --git a/source/blender/collada/DocumentImporter.h b/source/blender/collada/DocumentImporter.h index 96c587edc44..179461ba59d 100644 --- a/source/blender/collada/DocumentImporter.h +++ b/source/blender/collada/DocumentImporter.h @@ -80,7 +80,7 @@ public: /** This method will be called if an error in the loading process occurred and the loader cannot continue to load. The writer should undo all operations that have been performed. - @param errorMessage A message containing informations about the error that occurred. + \param errorMessage A message containing informations about the error that occurred. */ void cancel(const COLLADAFW::String& errorMessage); diff --git a/source/blender/editors/animation/anim_channels_defines.c b/source/blender/editors/animation/anim_channels_defines.c index fa349f1494b..f8bb690e31d 100644 --- a/source/blender/editors/animation/anim_channels_defines.c +++ b/source/blender/editors/animation/anim_channels_defines.c @@ -2498,7 +2498,7 @@ static void ANIM_init_channel_typeinfo_data (void) { int type= 0; - /* start initialising if necessary... */ + /* start initializing if necessary... */ if (ACF_INIT) { ACF_INIT= 0; @@ -3282,7 +3282,7 @@ void ANIM_channel_draw_widgets (bContext *C, bAnimContext *ac, bAnimListElem *al * - even if we can draw sliders for this view, we must also check that the channel-type supports them * (only only F-Curves really can support them for now) * - to make things easier, we use RNA-autobuts for this so that changes are reflected immediately, - * whereever they occurred. BUT, we don't use the layout engine, otherwise we'd get wrong alignment, + * wherever they occurred. BUT, we don't use the layout engine, otherwise we'd get wrong alignment, * and wouldn't be able to auto-keyframe... * - slider should start before the toggles (if they're visible) to keep a clean line down the side */ diff --git a/source/blender/editors/animation/anim_channels_edit.c b/source/blender/editors/animation/anim_channels_edit.c index bc3104ab7de..fc8947a2a58 100644 --- a/source/blender/editors/animation/anim_channels_edit.c +++ b/source/blender/editors/animation/anim_channels_edit.c @@ -367,7 +367,7 @@ void ANIM_deselect_anim_channels (bAnimContext *ac, void *data, short datatype, * - anim_data: list of the all the anim channels that can be chosen * -> filtered using ANIMFILTER_CHANNELS only, since if we took VISIBLE too, * then the channels under closed expanders get ignored... - * - ale_setting: the anim channel (not in the anim_data list directly, though occuring there) + * - ale_setting: the anim channel (not in the anim_data list directly, though occurring there) * with the new state of the setting that we want flushed up/down the hierarchy * - setting: type of setting to set * - on: whether the visibility setting has been enabled or disabled diff --git a/source/blender/editors/animation/anim_deps.c b/source/blender/editors/animation/anim_deps.c index 3f851938a83..8e91e575db1 100644 --- a/source/blender/editors/animation/anim_deps.c +++ b/source/blender/editors/animation/anim_deps.c @@ -115,7 +115,7 @@ void ANIM_id_update(Scene *UNUSED(scene), ID *id) } /* **************************** animation data <-> data syncing ******************************** */ -/* This code here is used to synchronise the +/* This code here is used to synchronize the * - selection (to find selected data easier) * - ... (insert other relevant items here later) * status in relevant Blender data with the status stored in animation channels. diff --git a/source/blender/editors/animation/anim_markers.c b/source/blender/editors/animation/anim_markers.c index 00c849ed02d..7e92c9eb690 100644 --- a/source/blender/editors/animation/anim_markers.c +++ b/source/blender/editors/animation/anim_markers.c @@ -232,7 +232,7 @@ void ED_markers_get_minmax (ListBase *markers, short sel, float *first, float *l selcount= BLI_countlist(markers); /* if only selected are to be considered, only consider the selected ones - * (optimisation for not searching list) + * (optimization for not searching list) */ if (selcount > 1) { for (marker= markers->first; marker; marker= marker->next) { @@ -323,7 +323,7 @@ TimeMarker *ED_markers_get_first_selected(ListBase *markers) /* --------------------------------- */ /* Print debugging prints of list of markers - * BSI's: do NOT make static or put in if-defs as "unused code". That's too much trouble when we need to use for quick debuggging! + * BSI's: do NOT make static or put in if-defs as "unused code". That's too much trouble when we need to use for quick debugging! */ void debug_markers_print_list(ListBase *markers) { @@ -933,7 +933,7 @@ static void ed_marker_duplicate_apply(bContext *C) return; /* go through the list of markers, duplicate selected markers and add duplicated copies - * to the begining of the list (unselect original markers) + * to the beginning of the list (unselect original markers) */ for (marker= markers->first; marker; marker= marker->next) { if (marker->flag & SELECT) { @@ -950,7 +950,7 @@ static void ed_marker_duplicate_apply(bContext *C) newmarker->camera= marker->camera; #endif - /* new marker is added to the begining of list */ + /* new marker is added to the beginning of list */ // FIXME: bad ordering! BLI_addhead(markers, newmarker); } @@ -1339,7 +1339,7 @@ static int ed_marker_rename_exec(bContext *C, wmOperator *op) static int ed_marker_rename_invoke_wrapper(bContext *C, wmOperator *op, wmEvent *evt) { - /* must initialise the marker name first if there is a marker selected */ + /* must initialize the marker name first if there is a marker selected */ TimeMarker *marker = ED_markers_get_first_selected(ED_context_get_markers(C)); if (marker) RNA_string_set(op->ptr, "name", marker->name); diff --git a/source/blender/editors/animation/fmodifier_ui.c b/source/blender/editors/animation/fmodifier_ui.c index a1949b87299..0b63a0ad752 100644 --- a/source/blender/editors/animation/fmodifier_ui.c +++ b/source/blender/editors/animation/fmodifier_ui.c @@ -312,7 +312,7 @@ static int binarysearch_fcm_envelopedata_index (FCM_EnvelopeData array[], float int start=0, end=arraylen; int loopbreaker= 0, maxloop= arraylen * 2; - /* initialise exists-flag first */ + /* initialize exists-flag first */ *exists= 0; /* sneaky optimisations (don't go through searching process if...): diff --git a/source/blender/editors/animation/keyframes_draw.c b/source/blender/editors/animation/keyframes_draw.c index c1e81cd0901..8b93688f4cb 100644 --- a/source/blender/editors/animation/keyframes_draw.c +++ b/source/blender/editors/animation/keyframes_draw.c @@ -374,7 +374,7 @@ static void add_bezt_to_keyblocks_list(DLRBT_Tree *blocks, DLRBT_Tree *beztTree, ActKeyBlock *ab, *abn=NULL; /* try to find a keyblock that starts on the previous beztriple, and add a new one if none start there - * Note: we can't search from end to try to optimise this as it causes errors there's + * Note: we can't search from end to try to optimize this as it causes errors there's * an A ___ B |---| B situation */ // FIXME: here there is a bug where we are trying to get the summary for the following channels @@ -499,7 +499,7 @@ void draw_keyframe_shape (float x, float y, float xscale, float hsize, short sel static GLuint displist1=0; static GLuint displist2=0; - /* initialise 2 display lists for diamond shape - one empty, one filled */ + /* initialize 2 display lists for diamond shape - one empty, one filled */ if (displist1 == 0) { displist1= glGenLists(1); glNewList(displist1, GL_COMPILE); @@ -621,7 +621,7 @@ static void draw_keylist(View2D *v2d, DLRBT_Tree *keys, DLRBT_Tree *blocks, floa float kalpha = (channelLocked)? 0.35f : 1.0f; for (ak= keys->first; ak; ak= ak->next) { - /* optimisation: if keyframe doesn't appear within 5 units (screenspace) in visible area, don't draw + /* optimization: if keyframe doesn't appear within 5 units (screenspace) in visible area, don't draw * - this might give some improvements, since we current have to flip between view/region matrices */ if (IN_RANGE_INCL(ak->cfra, v2d->cur.xmin, v2d->cur.xmax) == 0) diff --git a/source/blender/editors/animation/keyframing.c b/source/blender/editors/animation/keyframing.c index f66d77be795..5e617979716 100644 --- a/source/blender/editors/animation/keyframing.c +++ b/source/blender/editors/animation/keyframing.c @@ -446,7 +446,7 @@ static short new_key_needed (FCurve *fcu, float cFrame, float nValue) } else { /* just add a keyframe if there's only one keyframe - * and the new one occurs before the exisiting one does. + * and the new one occurs before the existing one does. */ if ((cFrame < beztPosi) && (totCount==1)) return KEYNEEDED_JUSTADD; diff --git a/source/blender/editors/armature/poseSlide.c b/source/blender/editors/armature/poseSlide.c index 6cb68ab0a06..8698ac00913 100644 --- a/source/blender/editors/armature/poseSlide.c +++ b/source/blender/editors/armature/poseSlide.c @@ -159,7 +159,7 @@ static int pose_slide_init (bContext *C, wmOperator *op, short mode) pso->ob->pose->flag |= POSE_LOCKED; pso->ob->pose->flag &= ~POSE_DO_UNLOCK; - /* do basic initialise of RB-BST used for finding keyframes, but leave the filling of it up + /* do basic initialize of RB-BST used for finding keyframes, but leave the filling of it up * to the caller of this (usually only invoke() will do it, to make things more efficient). */ BLI_dlrbTree_init(&pso->keys); @@ -730,7 +730,7 @@ static int pose_slide_push_invoke (bContext *C, wmOperator *op, wmEvent *UNUSED( { tPoseSlideOp *pso; - /* initialise data */ + /* initialize data */ if (pose_slide_init(C, op, POSESLIDE_PUSH) == 0) { pose_slide_exit(op); return OPERATOR_CANCELLED; @@ -747,7 +747,7 @@ static int pose_slide_push_exec (bContext *C, wmOperator *op) { tPoseSlideOp *pso; - /* initialise data (from RNA-props) */ + /* initialize data (from RNA-props) */ if (pose_slide_init(C, op, POSESLIDE_PUSH) == 0) { pose_slide_exit(op); return OPERATOR_CANCELLED; @@ -787,7 +787,7 @@ static int pose_slide_relax_invoke (bContext *C, wmOperator *op, wmEvent *UNUSED { tPoseSlideOp *pso; - /* initialise data */ + /* initialize data */ if (pose_slide_init(C, op, POSESLIDE_RELAX) == 0) { pose_slide_exit(op); return OPERATOR_CANCELLED; @@ -804,7 +804,7 @@ static int pose_slide_relax_exec (bContext *C, wmOperator *op) { tPoseSlideOp *pso; - /* initialise data (from RNA-props) */ + /* initialize data (from RNA-props) */ if (pose_slide_init(C, op, POSESLIDE_RELAX) == 0) { pose_slide_exit(op); return OPERATOR_CANCELLED; @@ -844,7 +844,7 @@ static int pose_slide_breakdown_invoke (bContext *C, wmOperator *op, wmEvent *UN { tPoseSlideOp *pso; - /* initialise data */ + /* initialize data */ if (pose_slide_init(C, op, POSESLIDE_BREAKDOWN) == 0) { pose_slide_exit(op); return OPERATOR_CANCELLED; @@ -861,7 +861,7 @@ static int pose_slide_breakdown_exec (bContext *C, wmOperator *op) { tPoseSlideOp *pso; - /* initialise data (from RNA-props) */ + /* initialize data (from RNA-props) */ if (pose_slide_init(C, op, POSESLIDE_BREAKDOWN) == 0) { pose_slide_exit(op); return OPERATOR_CANCELLED; diff --git a/source/blender/editors/armature/poseobject.c b/source/blender/editors/armature/poseobject.c index fead1f24a54..0d1a7c7173b 100644 --- a/source/blender/editors/armature/poseobject.c +++ b/source/blender/editors/armature/poseobject.c @@ -497,7 +497,7 @@ static short pose_select_same_group (bContext *C, Object *ob, short extend) } CTX_DATA_END; - /* small optimisation: only loop through bones a second time if there are any groups tagged */ + /* small optimization: only loop through bones a second time if there are any groups tagged */ if (tagged) { /* only if group matches (and is not selected or current bone) */ CTX_DATA_BEGIN(C, bPoseChannel *, pchan, visible_pose_bones) diff --git a/source/blender/editors/gpencil/drawgpencil.c b/source/blender/editors/gpencil/drawgpencil.c index cf3961e0820..19dc25dd282 100644 --- a/source/blender/editors/gpencil/drawgpencil.c +++ b/source/blender/editors/gpencil/drawgpencil.c @@ -286,7 +286,7 @@ static void gp_draw_stroke (bGPDspoint *points, int totpoints, short thickness_s glEnd(); } - /* tesselation code - draw stroke as series of connected quads with connection + /* tessellation code - draw stroke as series of connected quads with connection * edges rotated to minimise shrinking artifacts, and rounded endcaps */ else diff --git a/source/blender/editors/gpencil/gpencil_buttons.c b/source/blender/editors/gpencil/gpencil_buttons.c index 53ef16a70a0..46241f3d378 100644 --- a/source/blender/editors/gpencil/gpencil_buttons.c +++ b/source/blender/editors/gpencil/gpencil_buttons.c @@ -293,7 +293,7 @@ static void draw_gpencil_panel (bContext *C, uiLayout *layout, bGPdata *gpd, Poi } -/* Standard panel to be included whereever Grease Pencil is used... */ +/* Standard panel to be included wherever Grease Pencil is used... */ void gpencil_panel_standard(const bContext *C, Panel *pa) { bGPdata **gpd_ptr = NULL; diff --git a/source/blender/editors/gpencil/gpencil_paint.c b/source/blender/editors/gpencil/gpencil_paint.c index 5785637cf8b..21a9832cdc7 100644 --- a/source/blender/editors/gpencil/gpencil_paint.c +++ b/source/blender/editors/gpencil/gpencil_paint.c @@ -524,7 +524,7 @@ static void gp_stroke_simplify (tGPsdata *p) float co[2], pressure; int mco[2]; - /* initialise values */ + /* initialize values */ co[0]= 0; co[1]= 0; pressure = 0; @@ -802,7 +802,7 @@ static short gp_stroke_eraser_strokeinside (int mval[], int UNUSED(mvalo[]), sho } /* eraser tool - evaluation per stroke */ -// TODO: this could really do with some optimisation (KD-Tree/BVH?) +// TODO: this could really do with some optimization (KD-Tree/BVH?) static void gp_stroke_eraser_dostroke (tGPsdata *p, int mval[], int mvalo[], short rad, rcti *rect, bGPDframe *gpf, bGPDstroke *gps) { bGPDspoint *pt1, *pt2; @@ -1600,7 +1600,7 @@ static int gpencil_draw_exec (bContext *C, wmOperator *op) //printf("GPencil - Starting Re-Drawing \n"); - /* try to initialise context data needed while drawing */ + /* try to initialize context data needed while drawing */ if (!gpencil_draw_init(C, op)) { if (op->customdata) MEM_freeN(op->customdata); //printf("\tGP - no valid data \n"); @@ -1674,7 +1674,7 @@ static int gpencil_draw_invoke (bContext *C, wmOperator *op, wmEvent *event) if (G.f & G_DEBUG) printf("GPencil - Starting Drawing \n"); - /* try to initialise context data needed while drawing */ + /* try to initialize context data needed while drawing */ if (!gpencil_draw_init(C, op)) { if (op->customdata) MEM_freeN(op->customdata); diff --git a/source/blender/editors/include/BIF_glutil.h b/source/blender/editors/include/BIF_glutil.h index b5dbf906d84..77c50f9ca6d 100644 --- a/source/blender/editors/include/BIF_glutil.h +++ b/source/blender/editors/include/BIF_glutil.h @@ -55,27 +55,27 @@ extern unsigned char stipple_diag_stripes_neg[128]; /** * Draw a lined (non-looping) arc with the given - * @a radius, starting at angle @a start and arcing - * through @a angle. The arc is centered at the origin + * \a radius, starting at angle \a start and arcing + * through \a angle. The arc is centered at the origin * and drawn in the XY plane. * - * @param start The initial angle (in radians). - * @param angle The length of the arc (in radians). - * @param radius The arc radius. - * @param nsegments The number of segments to use in drawing the arc. + * \param start The initial angle (in radians). + * \param angle The length of the arc (in radians). + * \param radius The arc radius. + * \param nsegments The number of segments to use in drawing the arc. */ void glutil_draw_lined_arc (float start, float angle, float radius, int nsegments); /** - * Draw a filled arc with the given @a radius, - * starting at angle @a start and arcing through - * @a angle. The arc is centered at the origin + * Draw a filled arc with the given \a radius, + * starting at angle \a start and arcing through + * \a angle. The arc is centered at the origin * and drawn in the XY plane. * - * @param start The initial angle (in radians). - * @param angle The length of the arc (in radians). - * @param radius The arc radius. - * @param nsegments The number of segments to use in drawing the arc. + * \param start The initial angle (in radians). + * \param angle The length of the arc (in radians). + * \param radius The arc radius. + * \param nsegments The number of segments to use in drawing the arc. */ void glutil_draw_filled_arc (float start, float angle, float radius, int nsegments); @@ -93,11 +93,11 @@ float glaGetOneFloat (int param); /** * Functions like glRasterPos2i, except ensures that the resulting - * raster position is valid. @a known_good_x and @a known_good_y + * raster position is valid. \a known_good_x and \a known_good_y * should be coordinates of a point known to be within the current * view frustum. - * @attention This routine should be used when the distance of @a x - * and @a y away from the known good point is small (ie. for small icons + * \attention This routine should be used when the distance of \a x + * and \a y away from the known good point is small (ie. for small icons * and for bitmap characters), when drawing large+zoomed images it is * possible for overflow to occur, the glaDrawPixelsSafe routine should * be used instead. @@ -106,20 +106,20 @@ void glaRasterPosSafe2f (float x, float y, float known_good_x, float known_good /** * Functions like a limited glDrawPixels, except ensures that - * the image is displayed onscreen even if the @a x and @a y + * the image is displayed onscreen even if the \a x and \a y * coordinates for would be clipped. The routine respects the * glPixelZoom values, pixel unpacking parameters are _not_ * respected. - * @attention This routine makes many assumptions: the rect data + * \attention This routine makes many assumptions: the rect data * is expected to be in RGBA unsigned byte format, the coordinate * (0.375, 0.375) is assumed to be within the view frustum, and the * modelview and projection matrices are assumed to define a * 1-to-1 mapping to screen space. - * @attention Furthmore, in the case of zoomed or unpixel aligned + * \attention Furthmore, in the case of zoomed or unpixel aligned * images extending outside the view frustum, but still within the * window, some portion of the image may be visible left and/or - * below of the given @a x and @a y coordinates. It is recommended + * below of the given \a x and \a y coordinates. It is recommended * to use the glScissor functionality if images are to be drawn * with an inset view matrix. */ @@ -132,7 +132,7 @@ void glaDrawPixelsSafe (float x, float y, int img_w, int img_h, int row_w, int * clipped when offscreen. The routine respects the glPixelZoom values, * pixel unpacking parameters are _not_ respected. - * @attention This routine makes many assumptions: the rect data + * \attention This routine makes many assumptions: the rect data * is expected to be in RGBA byte or float format, and the * modelview and projection matrices are assumed to define a * 1-to-1 mapping to screen space. @@ -152,7 +152,7 @@ void glaDrawPixelsTexScaled(float x, float y, int img_w, int img_h, int format, * thus no reason to +-0.5 the coordinates or perform other silly * tricks. * - * @param screen_rect The screen rectangle to be defined for 2D drawing. + * \param screen_rect The screen rectangle to be defined for 2D drawing. */ void glaDefine2DArea (struct rcti *screen_rect); @@ -170,17 +170,17 @@ typedef struct gla2DDrawInfo gla2DDrawInfo; * thus no reason to +-0.5 the coordinates or perform other silly * tricks. * - * @param screen_rect The screen rectangle to be used for 2D drawing. - * @param world_rect The world rectangle that the 2D area represented - * by @a screen_rect is supposed to represent. If NULL it is assumed the + * \param screen_rect The screen rectangle to be used for 2D drawing. + * \param world_rect The world rectangle that the 2D area represented + * by \a screen_rect is supposed to represent. If NULL it is assumed the * world has a 1 to 1 mapping to the screen. */ gla2DDrawInfo* glaBegin2DDraw (struct rcti *screen_rect, struct rctf *world_rect); - /** Translate the (@a wo_x, @a wo_y) point from world coordinates into screen space. */ + /** Translate the (\a wo_x, \a wo_y) point from world coordinates into screen space. */ void gla2DDrawTranslatePt (gla2DDrawInfo *di, float wo_x, float wo_y, int *sc_x_r, int *sc_y_r); - /** Translate the @a world point from world coordiantes into screen space. */ + /** Translate the \a world point from world coordiantes into screen space. */ void gla2DDrawTranslatePtv (gla2DDrawInfo *di, float world[2], int screen_r[2]); /* Restores the previous OpenGL state and free's the auxilary diff --git a/source/blender/editors/include/ED_anim_api.h b/source/blender/editors/include/ED_anim_api.h index 2b00f854bb1..a9affbcd342 100644 --- a/source/blender/editors/include/ED_anim_api.h +++ b/source/blender/editors/include/ED_anim_api.h @@ -427,7 +427,7 @@ void ANIM_channel_setting_set(bAnimContext *ac, bAnimListElem *ale, int setting, * - anim_data: list of the all the anim channels that can be chosen * -> filtered using ANIMFILTER_CHANNELS only, since if we took VISIBLE too, * then the channels under closed expanders get ignored... - * - ale_setting: the anim channel (not in the anim_data list directly, though occuring there) + * - ale_setting: the anim channel (not in the anim_data list directly, though occurring there) * with the new state of the setting that we want flushed up/down the hierarchy * - setting: type of setting to set * - on: whether the visibility setting has been enabled or disabled diff --git a/source/blender/editors/include/ED_view3d.h b/source/blender/editors/include/ED_view3d.h index 4c68b53d5cd..23321e0e48f 100644 --- a/source/blender/editors/include/ED_view3d.h +++ b/source/blender/editors/include/ED_view3d.h @@ -91,10 +91,10 @@ int initgrabz(struct RegionView3D *rv3d, float x, float y, float z); /** * Calculate a 3d location from 2d window coordinates. - * @param ar The region (used for the window width and height). - * @param depth_pt The reference location used to calculate the Z depth. - * @param mval The area relative location (such as event->mval converted to floats). - * @param out The resulting world-space location. + * \param ar The region (used for the window width and height). + * \param depth_pt The reference location used to calculate the Z depth. + * \param mval The area relative location (such as event->mval converted to floats). + * \param out The resulting world-space location. */ void ED_view3d_win_to_3d(struct ARegion *ar, const float depth_pt[3], const float mval[2], float out[3]); @@ -102,9 +102,9 @@ void ED_view3d_win_to_3d(struct ARegion *ar, const float depth_pt[3], const floa * Calculate a 3d difference vector from 2d window offset. * note that initgrabz() must be called first to determine * the depth used to calculate the delta. - * @param ar The region (used for the window width and height). - * @param mval The area relative 2d difference (such as event->mval[0] - other_x). - * @param out The resulting world-space delta. + * \param ar The region (used for the window width and height). + * \param mval The area relative 2d difference (such as event->mval[0] - other_x). + * \param out The resulting world-space delta. */ void ED_view3d_win_to_delta(struct ARegion *ar, const float mval[2], float out[3]); @@ -112,9 +112,9 @@ void ED_view3d_win_to_delta(struct ARegion *ar, const float mval[2], float out[3 * Calculate a 3d direction vector from 2d window coordinates. * This direction vector starts and the view in the direction of the 2d window coordinates. * In orthographic view all window coordinates yield the same vector. - * @param ar The region (used for the window width and height). - * @param mval The area relative 2d location (such as event->mval converted to floats). - * @param out The resulting normalized world-space direction vector. + * \param ar The region (used for the window width and height). + * \param mval The area relative 2d location (such as event->mval converted to floats). + * \param out The resulting normalized world-space direction vector. */ void ED_view3d_win_to_vector(struct ARegion *ar, const float mval[2], float out[3]); @@ -124,11 +124,11 @@ void ED_view3d_win_to_vector(struct ARegion *ar, const float mval[2], float out[ * ray_start and ray_end are clipped by the view near and far limits * so points along this line are always in view. * In orthographic view all resulting segments will be parallel. - * @param ar The region (used for the window width and height). - * @param v3d The 3d viewport (used for near and far clipping range). - * @param mval The area relative 2d location (such as event->mval, converted into float[2]). - * @param ray_start The world-space starting point of the segment. - * @param ray_end The world-space end point of the segment. + * \param ar The region (used for the window width and height). + * \param v3d The 3d viewport (used for near and far clipping range). + * \param mval The area relative 2d location (such as event->mval, converted into float[2]). + * \param ray_start The world-space starting point of the segment. + * \param ray_end The world-space end point of the segment. */ void ED_view3d_win_to_segment_clip(struct ARegion *ar, struct View3D *v3d, const float mval[2], float ray_start[3], float ray_end[3]); @@ -137,58 +137,58 @@ void ED_view3d_win_to_segment_clip(struct ARegion *ar, struct View3D *v3d, const * This ray_start is located at the viewpoint, ray_normal is the direction towards mval. * ray_start is clipped by the view near limit so points in front of it are always in view. * In orthographic view the resulting ray_normal will match the view vector. - * @param ar The region (used for the window width and height). - * @param v3d The 3d viewport (used for near clipping value). - * @param mval The area relative 2d location (such as event->mval, converted into float[2]). - * @param ray_start The world-space starting point of the segment. - * @param ray_normal The normalized world-space direction of towards mval. + * \param ar The region (used for the window width and height). + * \param v3d The 3d viewport (used for near clipping value). + * \param mval The area relative 2d location (such as event->mval, converted into float[2]). + * \param ray_start The world-space starting point of the segment. + * \param ray_normal The normalized world-space direction of towards mval. */ void ED_view3d_win_to_ray(struct ARegion *ar, struct View3D *v3d, const float mval[2], float ray_start[3], float ray_normal[3]); /** * Calculate a normalized 3d direction vector from the viewpoint towards a global location. * In orthographic view the resulting vector will match the view vector. - * @param rv3d The region (used for the window width and height). - * @param coord The world-space location. - * @param vec The resulting normalized vector. + * \param rv3d The region (used for the window width and height). + * \param coord The world-space location. + * \param vec The resulting normalized vector. */ void ED_view3d_global_to_vector(struct RegionView3D *rv3d, const float coord[3], float vec[3]); /** * Calculate the view transformation matrix from RegionView3D input. * The resulting matrix is equivalent to RegionView3D.viewinv - * @param mat The view 4x4 transformation matrix to calculate. - * @param ofs The view offset, normally from RegionView3D.ofs. - * @param quat The view rotation, quaternion normally from RegionView3D.viewquat. - * @param dist The view distance from ofs, normally from RegionView3D.dist. + * \param mat The view 4x4 transformation matrix to calculate. + * \param ofs The view offset, normally from RegionView3D.ofs. + * \param quat The view rotation, quaternion normally from RegionView3D.viewquat. + * \param dist The view distance from ofs, normally from RegionView3D.dist. */ void ED_view3d_to_m4(float mat[][4], const float ofs[3], const float quat[4], const float dist); /** * Set the view transformation from a 4x4 matrix. - * @param mat The view 4x4 transformation matrix to assign. - * @param ofs The view offset, normally from RegionView3D.ofs. - * @param quat The view rotation, quaternion normally from RegionView3D.viewquat. - * @param dist The view distance from ofs, normally from RegionView3D.dist. + * \param mat The view 4x4 transformation matrix to assign. + * \param ofs The view offset, normally from RegionView3D.ofs. + * \param quat The view rotation, quaternion normally from RegionView3D.viewquat. + * \param dist The view distance from ofs, normally from RegionView3D.dist. */ void ED_view3d_from_m4(float mat[][4], float ofs[3], float quat[4], float *dist); /** * Set the RegionView3D members from an objects transformation and optionally lens. - * @param ob The object to set the view to. - * @param ofs The view offset to be set, normally from RegionView3D.ofs. - * @param quat The view rotation to be set, quaternion normally from RegionView3D.viewquat. - * @param dist The view distance from ofs to be set, normally from RegionView3D.dist. - * @param lens The view lens angle set for cameras and lamps, normally from View3D.lens. + * \param ob The object to set the view to. + * \param ofs The view offset to be set, normally from RegionView3D.ofs. + * \param quat The view rotation to be set, quaternion normally from RegionView3D.viewquat. + * \param dist The view distance from ofs to be set, normally from RegionView3D.dist. + * \param lens The view lens angle set for cameras and lamps, normally from View3D.lens. */ void ED_view3d_from_object(struct Object *ob, float ofs[3], float quat[4], float *dist, float *lens); /** * Set the object transformation from RegionView3D members. - * @param ob The object which has the transformation assigned. - * @param ofs The view offset, normally from RegionView3D.ofs. - * @param quat The view rotation, quaternion normally from RegionView3D.viewquat. - * @param dist The view distance from ofs, normally from RegionView3D.dist. + * \param ob The object which has the transformation assigned. + * \param ofs The view offset, normally from RegionView3D.ofs. + * \param quat The view rotation, quaternion normally from RegionView3D.viewquat. + * \param dist The view distance from ofs, normally from RegionView3D.dist. */ void ED_view3d_to_object(struct Object *ob, const float ofs[3], const float quat[4], const float dist); diff --git a/source/blender/editors/interface/interface_regions.c b/source/blender/editors/interface/interface_regions.c index c912bce1c77..32f284826a7 100644 --- a/source/blender/editors/interface/interface_regions.c +++ b/source/blender/editors/interface/interface_regions.c @@ -154,8 +154,8 @@ static void menudata_free(MenuData *md) * indicates a seperator, sss%l indicates a label and * new column. * - * @param str String to be parsed. - * @retval new menudata structure, free with menudata_free() + * \param str String to be parsed. + * \retval new menudata structure, free with menudata_free() */ static MenuData *decompose_menu_string(const char *str) { diff --git a/source/blender/editors/interface/interface_templates.c b/source/blender/editors/interface/interface_templates.c index 0b10ab1c92f..91a2b76eae4 100644 --- a/source/blender/editors/interface/interface_templates.c +++ b/source/blender/editors/interface/interface_templates.c @@ -792,7 +792,7 @@ static uiLayout *draw_modifier(uiLayout *layout, Scene *scene, Object *ob, uiButSetFlag(but, UI_BUT_DISABLED); uiBlockSetEmboss(block, UI_EMBOSS); } - } /* tesselation point for curve-typed objects */ + } /* tessellation point for curve-typed objects */ else if (ELEM3(ob->type, OB_CURVE, OB_SURF, OB_FONT)) { /* some modifiers could work with pre-tesselated curves only */ if (ELEM3(md->type, eModifierType_Hook, eModifierType_Softbody, eModifierType_MeshDeform)) { diff --git a/source/blender/editors/interface/view2d.c b/source/blender/editors/interface/view2d.c index 42052dcea4f..e8d4cba81c8 100644 --- a/source/blender/editors/interface/view2d.c +++ b/source/blender/editors/interface/view2d.c @@ -168,7 +168,7 @@ void UI_view2d_region_reinit(View2D *v2d, short type, int winx, int winy) short tot_changed= 0, init= 0; uiStyle *style= UI_GetStyle(); - /* initialise data if there is a need for such */ + /* initialize data if there is a need for such */ if ((v2d->flag & V2D_IS_INITIALISED) == 0) { /* set initialised flag so that View2D doesn't get reinitialised next time again */ v2d->flag |= V2D_IS_INITIALISED; @@ -1200,7 +1200,7 @@ void UI_view2d_grid_draw(View2D *v2d, View2DGrid *grid, int flag) /* vertical lines */ if (flag & V2D_VERTICAL_LINES) { - /* initialise initial settings */ + /* initialize initial settings */ vec1[0]= vec2[0]= grid->startx; vec1[1]= grid->starty; vec2[1]= v2d->cur.ymax; diff --git a/source/blender/editors/interface/view2d_ops.c b/source/blender/editors/interface/view2d_ops.c index 234b2733bd3..6632cfc62ac 100644 --- a/source/blender/editors/interface/view2d_ops.c +++ b/source/blender/editors/interface/view2d_ops.c @@ -90,7 +90,7 @@ typedef struct v2dViewPanData { short in_scroller; /* for MMB in scrollers (old feature in past, but now not that useful) */ } v2dViewPanData; -/* initialise panning customdata */ +/* initialize panning customdata */ static int view_pan_init(bContext *C, wmOperator *op) { ARegion *ar= CTX_wm_region(C); @@ -315,7 +315,7 @@ static int view_scrollright_exec(bContext *C, wmOperator *op) { v2dViewPanData *vpd; - /* initialise default settings (and validate if ok to run) */ + /* initialize default settings (and validate if ok to run) */ if (!view_pan_init(C, op)) return OPERATOR_PASS_THROUGH; @@ -359,7 +359,7 @@ static int view_scrollleft_exec(bContext *C, wmOperator *op) { v2dViewPanData *vpd; - /* initialise default settings (and validate if ok to run) */ + /* initialize default settings (and validate if ok to run) */ if (!view_pan_init(C, op)) return OPERATOR_PASS_THROUGH; @@ -402,7 +402,7 @@ static int view_scrolldown_exec(bContext *C, wmOperator *op) { v2dViewPanData *vpd; - /* initialise default settings (and validate if ok to run) */ + /* initialize default settings (and validate if ok to run) */ if (!view_pan_init(C, op)) return OPERATOR_PASS_THROUGH; @@ -452,7 +452,7 @@ static int view_scrollup_exec(bContext *C, wmOperator *op) { v2dViewPanData *vpd; - /* initialise default settings (and validate if ok to run) */ + /* initialize default settings (and validate if ok to run) */ if (!view_pan_init(C, op)) return OPERATOR_PASS_THROUGH; @@ -527,7 +527,7 @@ typedef struct v2dViewZoomData { } v2dViewZoomData; -/* initialise panning customdata */ +/* initialize panning customdata */ static int view_zoomdrag_init(bContext *C, wmOperator *op) { ARegion *ar= CTX_wm_region(C); @@ -1286,7 +1286,7 @@ static short mouse_in_scroller_handle(int mouse, int sc_min, int sc_max, int sh_ return SCROLLHANDLE_BAR; } -/* initialise customdata for scroller manipulation operator */ +/* initialize customdata for scroller manipulation operator */ static void scroller_activate_init(bContext *C, wmOperator *op, wmEvent *event, short in_scroller) { v2dScrollerMove *vsm; @@ -1510,7 +1510,7 @@ static int scroller_activate_invoke(bContext *C, wmOperator *op, wmEvent *event) if (in_scroller) { v2dScrollerMove *vsm; - /* initialise customdata */ + /* initialize customdata */ scroller_activate_init(C, op, event, in_scroller); vsm= (v2dScrollerMove *)op->customdata; diff --git a/source/blender/editors/mesh/bmesh_tools.c b/source/blender/editors/mesh/bmesh_tools.c index daa03d2726f..18b89b8be80 100644 --- a/source/blender/editors/mesh/bmesh_tools.c +++ b/source/blender/editors/mesh/bmesh_tools.c @@ -516,7 +516,7 @@ static int mesh_extrude_region_exec(bContext *C, wmOperator *op) * like this one don't push undo data until after modal mode is * done.*/ EDBM_RecalcNormals(em); - BMEdit_RecalcTesselation(em); + BMEdit_RecalcTessellation(em); WM_event_add_notifier(C, NC_GEOM|ND_SELECT, obedit); @@ -876,7 +876,7 @@ static int dupli_extrude_cursor(bContext *C, wmOperator *op, wmEvent *event) * like this one don't push undo data until after modal mode is * done. */ EDBM_RecalcNormals(vc.em); - BMEdit_RecalcTesselation(vc.em); + BMEdit_RecalcTessellation(vc.em); WM_event_add_notifier(C, NC_GEOM|ND_DATA, vc.obedit->data); DAG_id_tag_update(vc.obedit->data, OB_RECALC_DATA); @@ -3249,7 +3249,7 @@ static int mesh_separate_selected(Main *bmain, Scene *scene, Base *editbase, wmO EDBM_CallOpf(em, wmop, "del geom=%hvef context=%i", BM_ELEM_SELECT, DEL_VERTS); BM_mesh_normals_update(bm_new, TRUE); - BMO_op_callf(bm_new, "bmesh_to_mesh mesh=%p object=%p notesselation=%b", + BMO_op_callf(bm_new, "bmesh_to_mesh mesh=%p object=%p notessellation=%b", basenew->object->data, basenew->object, TRUE); BM_mesh_free(bm_new); @@ -3592,7 +3592,7 @@ static int split_mesh_exec(bContext *C, wmOperator *op) } /* Geometry has changed, need to recalc normals and looptris */ - BMEdit_RecalcTesselation(em); + BMEdit_RecalcTessellation(em); EDBM_RecalcNormals(em); DAG_id_tag_update(ob->data, OB_RECALC_DATA); diff --git a/source/blender/editors/mesh/bmesh_utils.c b/source/blender/editors/mesh/bmesh_utils.c index 892184e94ad..0f9bc29a16d 100644 --- a/source/blender/editors/mesh/bmesh_utils.c +++ b/source/blender/editors/mesh/bmesh_utils.c @@ -73,7 +73,7 @@ void EDBM_ClearMesh(BMEditMesh *em) em->derivedCage = em->derivedFinal = NULL; - /* free tesselation data */ + /* free tessellation data */ em->tottri = 0; if (em->looptris) MEM_freeN(em->looptris); @@ -143,7 +143,7 @@ int EDBM_FinishOp(BMEditMesh *em, BMOperator *bmop, wmOperator *op, const int re BMEdit_Free(em); *em = *emcopy; - BMEdit_RecalcTesselation(em); + BMEdit_RecalcTessellation(em); MEM_freeN(emcopy); em->emcopyusers = 0; @@ -521,13 +521,13 @@ static void *editbtMesh_to_undoMesh(void *emv, void *obdata) #ifdef BMESH_EM_UNDO_RECALC_TESSFACE_WORKAROUND - /* we recalc the tesselation here, to avoid seeding calls to - * BMEdit_RecalcTesselation throughout the code. */ - BMEdit_RecalcTesselation(em); + /* we recalc the tessellation here, to avoid seeding calls to + * BMEdit_RecalcTessellation throughout the code. */ + BMEdit_RecalcTessellation(em); #endif - BMO_op_callf(em->bm, "bmesh_to_mesh mesh=%p notesselation=%b", &um->me, TRUE); + BMO_op_callf(em->bm, "bmesh_to_mesh mesh=%p notessellation=%b", &um->me, TRUE); um->selectmode = em->selectmode; return um; diff --git a/source/blender/editors/mesh/editmesh_bvh.c b/source/blender/editors/mesh/editmesh_bvh.c index cc1f89e2c8b..fc7818183bb 100644 --- a/source/blender/editors/mesh/editmesh_bvh.c +++ b/source/blender/editors/mesh/editmesh_bvh.c @@ -90,7 +90,7 @@ BMBVHTree *BMBVH_NewBVH(BMEditMesh *em, int flag, Scene *scene, Object *obedit) so that e.g. mirror or array use original vertex coordiantes and not mirrored or duplicate*/ BLI_smallhash_init(&shash); - BMEdit_RecalcTesselation(em); + BMEdit_RecalcTessellation(em); tree->ob = obedit; tree->scene = scene; diff --git a/source/blender/editors/mesh/meshtools.c b/source/blender/editors/mesh/meshtools.c index bad0718c613..7bf41bdce00 100644 --- a/source/blender/editors/mesh/meshtools.c +++ b/source/blender/editors/mesh/meshtools.c @@ -594,7 +594,7 @@ int join_mesh_shapes_exec(bContext *C, wmOperator *op) key= me->key= add_key((ID *)me); key->type= KEY_RELATIVE; - /* first key added, so it was the basis. initialise it with the existing mesh */ + /* first key added, so it was the basis. initialize it with the existing mesh */ kb= add_keyblock(key, NULL); mesh_to_key(me, kb); } diff --git a/source/blender/editors/object/object_add.c b/source/blender/editors/object/object_add.c index 27ed9f5b46e..29526825736 100644 --- a/source/blender/editors/object/object_add.c +++ b/source/blender/editors/object/object_add.c @@ -1372,7 +1372,7 @@ static int convert_exec(bContext *C, wmOperator *op) DM_to_mesh(dm, newob->data, newob); - /* re-tesselation is called by DM_to_mesh */ + /* re-tessellation is called by DM_to_mesh */ dm->release(dm); object_free_modifiers(newob); /* after derivedmesh calls! */ diff --git a/source/blender/editors/object/object_modifier.c b/source/blender/editors/object/object_modifier.c index d53f414336d..c5d81969098 100644 --- a/source/blender/editors/object/object_modifier.c +++ b/source/blender/editors/object/object_modifier.c @@ -1655,7 +1655,7 @@ static int ocean_bake_exec(bContext *C, wmOperator *op) for (f=omd->bakestart; f<=omd->bakeend; f++) { /* from physics_fluid.c: - * XXX: This can't be used due to an anim sys optimisation that ignores recalc object animation, + * XXX: This can't be used due to an anim sys optimization that ignores recalc object animation, * leaving it for the depgraph (this ignores object animation such as modifier properties though... :/ ) * --> BKE_animsys_evaluate_all_animation(G.main, eval_time); * This doesn't work with drivers: diff --git a/source/blender/editors/physics/physics_fluid.c b/source/blender/editors/physics/physics_fluid.c index e8ada1e0655..d3af007d2e6 100644 --- a/source/blender/editors/physics/physics_fluid.c +++ b/source/blender/editors/physics/physics_fluid.c @@ -423,7 +423,7 @@ static void fluid_init_all_channels(bContext *C, Object *UNUSED(fsDomain), Fluid eval_time = domainSettings->bakeStart + i; - /* XXX: This can't be used due to an anim sys optimisation that ignores recalc object animation, + /* XXX: This can't be used due to an anim sys optimization that ignores recalc object animation, * leaving it for the depgraph (this ignores object animation such as modifier properties though... :/ ) * --> BKE_animsys_evaluate_all_animation(G.main, eval_time); * This doesn't work with drivers: @@ -975,7 +975,7 @@ static int fluidsimBake(bContext *C, ReportList *reports, Object *fsDomain, shor channels->length = scene->r.efra; channels->aniFrameTime = (domainSettings->animEnd - domainSettings->animStart)/(double)noFrames; - /* ******** initialise and allocate animation channels ******** */ + /* ******** initialize and allocate animation channels ******** */ fluid_init_all_channels(C, fsDomain, domainSettings, channels, fobjects); /* reset to original current frame */ diff --git a/source/blender/editors/screen/glutil.c b/source/blender/editors/screen/glutil.c index 235c5da08c3..918df2f90e0 100644 --- a/source/blender/editors/screen/glutil.c +++ b/source/blender/editors/screen/glutil.c @@ -410,7 +410,7 @@ void glaRasterPosSafe2f(float x, float y, float known_good_x, float known_good_y GLubyte dummy= 0; /* As long as known good coordinates are correct - * this is guarenteed to generate an ok raster + * this is guaranteed to generate an ok raster * position (ignoring potential (real) overflow * issues). */ diff --git a/source/blender/editors/sculpt_paint/paint_vertex.c b/source/blender/editors/sculpt_paint/paint_vertex.c index ad5aeea1b18..1937cb7b05c 100644 --- a/source/blender/editors/sculpt_paint/paint_vertex.c +++ b/source/blender/editors/sculpt_paint/paint_vertex.c @@ -2837,8 +2837,8 @@ static void vpaint_paint_poly(VPaint *vp, VPaintData *vpd, Object *ob, #endif #define CPYCOL(c, l) (c)->a = (l)->a, (c)->r = (l)->r, (c)->g = (l)->g, (c)->b = (l)->b - /* update vertex colors for tesselations incrementally, - * rather then regenerating the tesselation altogether */ + /* update vertex colors for tessellations incrementally, + * rather then regenerating the tessellation altogether */ for (e = vpd->polyfacemap[index].first; e; e = e->next) { mf = me->mface + e->facenr; mc = me->mcol + e->facenr*4; diff --git a/source/blender/editors/space_action/action_draw.c b/source/blender/editors/space_action/action_draw.c index 309b455e2a2..f29dba4c568 100644 --- a/source/blender/editors/space_action/action_draw.c +++ b/source/blender/editors/space_action/action_draw.c @@ -300,7 +300,7 @@ void draw_channel_strips(bAnimContext *ac, SpaceAction *saction, ARegion *ar) /* Draw keyframes * 1) Only channels that are visible in the Action Editor get drawn/evaluated. - * This is to try to optimise this for heavier data sets + * This is to try to optimize this for heavier data sets * 2) Keyframes which are out of view horizontally are disregarded */ y= (float)(-ACHANNEL_HEIGHT); diff --git a/source/blender/editors/space_action/action_select.c b/source/blender/editors/space_action/action_select.c index 2909db71f73..1b0b305b7aa 100644 --- a/source/blender/editors/space_action/action_select.c +++ b/source/blender/editors/space_action/action_select.c @@ -422,7 +422,7 @@ static void columnselect_action_keys (bAnimContext *ac, short mode) KeyframeEditFunc select_cb, ok_cb; KeyframeEditData ked= {{NULL}}; - /* initialise keyframe editing data */ + /* initialize keyframe editing data */ /* build list of columns */ switch (mode) { diff --git a/source/blender/editors/space_clip/clip_graph_draw.c b/source/blender/editors/space_clip/clip_graph_draw.c index 6fabe802ff0..1e21d0e5120 100644 --- a/source/blender/editors/space_clip/clip_graph_draw.c +++ b/source/blender/editors/space_clip/clip_graph_draw.c @@ -63,7 +63,7 @@ static void draw_curve_knot(float x, float y, float xscale, float yscale, float { static GLuint displist=0; - /* initialise round circle shape */ + /* initialize round circle shape */ if (displist == 0) { GLUquadricObj *qobj; diff --git a/source/blender/editors/space_file/fsmenu.h b/source/blender/editors/space_file/fsmenu.h index 0d046fd985d..c926a4f382c 100644 --- a/source/blender/editors/space_file/fsmenu.h +++ b/source/blender/editors/space_file/fsmenu.h @@ -50,21 +50,21 @@ struct FSMenu* fsmenu_get (void); /** Returns the number of entries in the Fileselect Menu */ int fsmenu_get_nentries (struct FSMenu* fsmenu, FSMenuCategory category); - /** Returns the fsmenu entry at @a index (or NULL if a bad index) + /** Returns the fsmenu entry at \a index (or NULL if a bad index) * or a separator. */ char* fsmenu_get_entry (struct FSMenu* fsmenu, FSMenuCategory category, int index); - /** Inserts a new fsmenu entry with the given @a path. + /** Inserts a new fsmenu entry with the given \a path. * Duplicate entries are not added. - * @param sorted Should entry be inserted in sorted order? + * \param sorted Should entry be inserted in sorted order? */ void fsmenu_insert_entry (struct FSMenu* fsmenu, FSMenuCategory category, const char *path, int sorted, short save); /** Return whether the entry was created by the user and can be saved and deleted */ short fsmenu_can_save (struct FSMenu* fsmenu, FSMenuCategory category, int index); - /** Removes the fsmenu entry at the given @a index. */ + /** Removes the fsmenu entry at the given \a index. */ void fsmenu_remove_entry (struct FSMenu* fsmenu, FSMenuCategory category, int index); /** saves the 'bookmarks' to the specified file */ diff --git a/source/blender/editors/space_graph/graph_buttons.c b/source/blender/editors/space_graph/graph_buttons.c index e2ea6849a72..1115d3c4cb4 100644 --- a/source/blender/editors/space_graph/graph_buttons.c +++ b/source/blender/editors/space_graph/graph_buttons.c @@ -458,7 +458,7 @@ static void graph_panel_driverVar__singleProp(uiLayout *layout, ID *id, DriverVa PointerRNA dtar_ptr; uiLayout *row, *col; - /* initialise RNA pointer to the target */ + /* initialize RNA pointer to the target */ RNA_pointer_create(id, &RNA_DriverTarget, dtar, &dtar_ptr); /* Target ID */ @@ -489,7 +489,7 @@ static void graph_panel_driverVar__rotDiff(uiLayout *layout, ID *id, DriverVar * PointerRNA dtar_ptr, dtar2_ptr; uiLayout *col; - /* initialise RNA pointer to the target */ + /* initialize RNA pointer to the target */ RNA_pointer_create(id, &RNA_DriverTarget, dtar, &dtar_ptr); RNA_pointer_create(id, &RNA_DriverTarget, dtar2, &dtar2_ptr); @@ -525,7 +525,7 @@ static void graph_panel_driverVar__locDiff(uiLayout *layout, ID *id, DriverVar * PointerRNA dtar_ptr, dtar2_ptr; uiLayout *col; - /* initialise RNA pointer to the target */ + /* initialize RNA pointer to the target */ RNA_pointer_create(id, &RNA_DriverTarget, dtar, &dtar_ptr); RNA_pointer_create(id, &RNA_DriverTarget, dtar2, &dtar2_ptr); @@ -563,7 +563,7 @@ static void graph_panel_driverVar__transChan(uiLayout *layout, ID *id, DriverVar PointerRNA dtar_ptr; uiLayout *col, *sub; - /* initialise RNA pointer to the target */ + /* initialize RNA pointer to the target */ RNA_pointer_create(id, &RNA_DriverTarget, dtar, &dtar_ptr); /* properties */ diff --git a/source/blender/editors/space_graph/graph_draw.c b/source/blender/editors/space_graph/graph_draw.c index b8752ffa775..f1afb3c82db 100644 --- a/source/blender/editors/space_graph/graph_draw.c +++ b/source/blender/editors/space_graph/graph_draw.c @@ -153,7 +153,7 @@ static void draw_fcurve_vertices_keyframes (FCurve *fcu, SpaceIpo *UNUSED(sipo), bglBegin(GL_POINTS); for (i = 0; i < fcu->totvert; i++, bezt++) { - /* as an optimisation step, only draw those in view + /* as an optimization step, only draw those in view * - we apply a correction factor to ensure that points don't pop in/out due to slight twitches of view size */ if IN_RANGE(bezt->vec[1][0], (v2d->cur.xmin - fac), (v2d->cur.xmax + fac)) { @@ -185,7 +185,7 @@ static void draw_fcurve_handle_control (float x, float y, float xscale, float ys { static GLuint displist=0; - /* initialise round circle shape */ + /* initialize round circle shape */ if (displist == 0) { GLUquadricObj *qobj; @@ -428,7 +428,7 @@ static void draw_fcurve_sample_control (float x, float y, float xscale, float ys { static GLuint displist=0; - /* initialise X shape */ + /* initialize X shape */ if (displist == 0) { displist= glGenLists(1); glNewList(displist, GL_COMPILE); @@ -678,7 +678,7 @@ static void draw_fcurve_curve_bezts (bAnimContext *ac, ID *id, FCurve *fcu, View } /* draw curve between first and last keyframe (if there are enough to do so) */ - // TODO: optimise this to not have to calc stuff out of view too? + // TODO: optimize this to not have to calc stuff out of view too? while (b--) { if (prevbezt->ipo==BEZT_IPO_CONST) { /* Constant-Interpolation: draw segment between previous keyframe and next, but holding same value */ diff --git a/source/blender/editors/space_graph/graph_edit.c b/source/blender/editors/space_graph/graph_edit.c index fbcb9546a1b..ffe5147074a 100644 --- a/source/blender/editors/space_graph/graph_edit.c +++ b/source/blender/editors/space_graph/graph_edit.c @@ -1582,7 +1582,7 @@ static int graphkeys_euler_filter_exec (bContext *C, wmOperator *op) continue; } - /* optimisation: assume that xyz curves will always be stored consecutively, + /* optimization: assume that xyz curves will always be stored consecutively, * so if the paths or the ID's don't match up, then a curve needs to be added * to a new group */ diff --git a/source/blender/editors/space_graph/graph_select.c b/source/blender/editors/space_graph/graph_select.c index 9a0f04f418e..2307f1db4f2 100644 --- a/source/blender/editors/space_graph/graph_select.c +++ b/source/blender/editors/space_graph/graph_select.c @@ -449,7 +449,7 @@ static void columnselect_graph_keys (bAnimContext *ac, short mode) KeyframeEditFunc select_cb, ok_cb; KeyframeEditData ked; - /* initialise keyframe editing data */ + /* initialize keyframe editing data */ memset(&ked, 0, sizeof(KeyframeEditData)); /* build list of columns */ @@ -1180,7 +1180,7 @@ static void mouse_graph_keys (bAnimContext *ac, const int mval[2], short select_ KeyframeEditFunc select_cb; KeyframeEditData ked; - /* initialise keyframe editing data */ + /* initialize keyframe editing data */ memset(&ked, 0, sizeof(KeyframeEditData)); /* set up BezTriple edit callbacks */ @@ -1262,7 +1262,7 @@ static void graphkeys_mselect_column (bAnimContext *ac, const int mval[2], short deselect_graph_keys(ac, 0, SELECT_SUBTRACT, FALSE); } - /* initialise keyframe editing data */ + /* initialize keyframe editing data */ memset(&ked, 0, sizeof(KeyframeEditData)); /* set up BezTriple edit callbacks */ diff --git a/source/blender/editors/space_info/info_ops.c b/source/blender/editors/space_info/info_ops.c index 54e8b1b490d..e4febdef73b 100644 --- a/source/blender/editors/space_info/info_ops.c +++ b/source/blender/editors/space_info/info_ops.c @@ -362,7 +362,7 @@ static int update_reports_display_invoke(bContext *C, wmOperator *UNUSED(op), wm } if (rti->widthfac == 0.0f) { - /* initialise colors based on report type */ + /* initialize colors based on report type */ if(report->type & RPT_ERROR_ALL) { rti->col[0] = 1.0; rti->col[1] = 0.2; diff --git a/source/blender/editors/space_nla/nla_edit.c b/source/blender/editors/space_nla/nla_edit.c index d7dfea0b7e7..a142119d685 100644 --- a/source/blender/editors/space_nla/nla_edit.c +++ b/source/blender/editors/space_nla/nla_edit.c @@ -1619,7 +1619,7 @@ void NLA_OT_action_sync_length (wmOperatorType *ot) /* identifiers */ ot->name= "Sync Action Length"; ot->idname= "NLA_OT_action_sync_length"; - ot->description= "Synchronise the length of the referenced Action with the length used in the strip"; + ot->description= "Synchronize the length of the referenced Action with the length used in the strip"; /* api callbacks */ ot->exec= nlaedit_sync_actlen_exec; diff --git a/source/blender/editors/space_outliner/outliner_edit.c b/source/blender/editors/space_outliner/outliner_edit.c index de798e5c23b..ca0a9c15c8c 100644 --- a/source/blender/editors/space_outliner/outliner_edit.c +++ b/source/blender/editors/space_outliner/outliner_edit.c @@ -978,7 +978,7 @@ static void tree_element_to_path(SpaceOops *soops, TreeElement *te, TreeStoreEle PropertyRNA *prop; char *newpath=NULL; - /* optimise tricks: + /* optimize tricks: * - Don't do anything if the selected item is a 'struct', but arrays are allowed */ if (tselem->type == TSE_RNA_STRUCT) diff --git a/source/blender/editors/space_sequencer/sequencer_select.c b/source/blender/editors/space_sequencer/sequencer_select.c index 55fc84b6707..32c7be99e94 100644 --- a/source/blender/editors/space_sequencer/sequencer_select.c +++ b/source/blender/editors/space_sequencer/sequencer_select.c @@ -1094,7 +1094,7 @@ static short select_grouped_effect_link(Editing *ed, Sequence *actseq) seq->flag |= SELECT; changed = TRUE; - /* Unfortunately, we must restart checks from the begining. */ + /* Unfortunately, we must restart checks from the beginning. */ seq_end(&iter); seq_begin(ed, &iter, 1); } diff --git a/source/blender/editors/space_text/text_ops.c b/source/blender/editors/space_text/text_ops.c index db8c1b230ba..a44d5909a4f 100644 --- a/source/blender/editors/space_text/text_ops.c +++ b/source/blender/editors/space_text/text_ops.c @@ -1133,7 +1133,7 @@ static int text_convert_whitespace_exec(bContext *C, wmOperator *op) } if(type == TO_TABS) // Converting to tabs - { //start over from the begining + { //start over from the beginning tmp = text->lines.first; while(tmp) { diff --git a/source/blender/editors/space_view3d/drawarmature.c b/source/blender/editors/space_view3d/drawarmature.c index 705b3c52d4b..e611ae1b64c 100644 --- a/source/blender/editors/space_view3d/drawarmature.c +++ b/source/blender/editors/space_view3d/drawarmature.c @@ -662,7 +662,7 @@ static void draw_sphere_bone_dist(float smat[][4], float imat[][4], bPoseChannel dirvec[2]= 0.0f; if (head != tail) { - /* correcyion when viewing along the bones axis + /* correction when viewing along the bones axis * it pops in and out but better then artifacts, [#23841] */ float view_dist= len_v2(dirvec); diff --git a/source/blender/editors/space_view3d/drawobject.c b/source/blender/editors/space_view3d/drawobject.c index 4b58c93fa05..ad3c223432a 100644 --- a/source/blender/editors/space_view3d/drawobject.c +++ b/source/blender/editors/space_view3d/drawobject.c @@ -4133,7 +4133,7 @@ static void draw_particle(ParticleKey *state, int draw_as, short draw, float pix /* mostly tries to use vertex arrays for speed */ /* 1. check that everything is ok & updated */ -/* 2. start initialising things */ +/* 2. start initializing things */ /* 3. initialize according to draw type */ /* 4. allocate drawing data arrays */ /* 5. start filling the arrays */ diff --git a/source/blender/editors/transform/transform.c b/source/blender/editors/transform/transform.c index e2d7189088c..f41d826f930 100644 --- a/source/blender/editors/transform/transform.c +++ b/source/blender/editors/transform/transform.c @@ -5436,7 +5436,7 @@ void initTimeTranslate(TransInfo *t) t->num.flag = 0; t->num.idx_max = t->idx_max; - /* initialise snap like for everything else */ + /* initialize snap like for everything else */ t->snap[0] = 0.0f; t->snap[1] = t->snap[2] = 1.0f; @@ -5590,7 +5590,7 @@ void initTimeSlide(TransInfo *t) t->num.flag = 0; t->num.idx_max = t->idx_max; - /* initialise snap like for everything else */ + /* initialize snap like for everything else */ t->snap[0] = 0.0f; t->snap[1] = t->snap[2] = 1.0f; @@ -5732,7 +5732,7 @@ void initTimeScale(TransInfo *t) t->num.flag = 0; t->num.idx_max = t->idx_max; - /* initialise snap like for everything else */ + /* initialize snap like for everything else */ t->snap[0] = 0.0f; t->snap[1] = t->snap[2] = 1.0f; diff --git a/source/blender/editors/transform/transform_conversions.c b/source/blender/editors/transform/transform_conversions.c index 1b4a75f80e8..d6097615ff6 100644 --- a/source/blender/editors/transform/transform_conversions.c +++ b/source/blender/editors/transform/transform_conversions.c @@ -1095,7 +1095,7 @@ static void createTransPose(TransInfo *t, Object *ob) // BKE_report(op->reports, RPT_DEBUG, "Bone selection count error"); } - /* initialise initial auto=ik chainlen's? */ + /* initialize initial auto=ik chainlen's? */ if (ik_on) transform_autoik_update(t, 0); } @@ -3650,7 +3650,7 @@ static void sort_time_beztmaps (BeztMap *bezms, int totvert, const short UNUSED( } /* do we need to check if the handles need to be swapped? - * optimisation: this only needs to be performed in the first loop + * optimization: this only needs to be performed in the first loop */ if (bezm->swapHs == 0) { if ( (bezm->bezt->vec[0][0] > bezm->bezt->vec[1][0]) && @@ -4947,7 +4947,7 @@ void special_aftertrans_update(bContext *C, TransInfo *t) SpaceAction *saction= (SpaceAction *)t->sa->spacedata.first; bAnimContext ac; - /* initialise relevant anim-context 'context' data */ + /* initialize relevant anim-context 'context' data */ if (ANIM_animdata_get_context(C, &ac) == 0) return; @@ -5062,7 +5062,7 @@ void special_aftertrans_update(bContext *C, TransInfo *t) bAnimContext ac; const short use_handle = !(sipo->flag & SIPO_NOHANDLES); - /* initialise relevant anim-context 'context' data */ + /* initialize relevant anim-context 'context' data */ if (ANIM_animdata_get_context(C, &ac) == 0) return; @@ -5112,7 +5112,7 @@ void special_aftertrans_update(bContext *C, TransInfo *t) else if (t->spacetype == SPACE_NLA) { bAnimContext ac; - /* initialise relevant anim-context 'context' data */ + /* initialize relevant anim-context 'context' data */ if (ANIM_animdata_get_context(C, &ac) == 0) return; diff --git a/source/blender/editors/transform/transform_generics.c b/source/blender/editors/transform/transform_generics.c index 2f349ae6f2a..557a6936f2f 100644 --- a/source/blender/editors/transform/transform_generics.c +++ b/source/blender/editors/transform/transform_generics.c @@ -339,7 +339,7 @@ static void recalcData_actedit(TransInfo *t) bAnimListElem *ale; int filter; - /* initialise relevant anim-context 'context' data from TransInfo data */ + /* initialize relevant anim-context 'context' data from TransInfo data */ /* NOTE: sync this with the code in ANIM_animdata_get_context() */ ac.scene= t->scene; ac.obact= OBACT; @@ -389,7 +389,7 @@ static void recalcData_graphedit(TransInfo *t) int dosort = 0; - /* initialise relevant anim-context 'context' data from TransInfo data */ + /* initialize relevant anim-context 'context' data from TransInfo data */ /* NOTE: sync this with the code in ANIM_animdata_get_context() */ scene= ac.scene= t->scene; ac.obact= OBACT; @@ -727,7 +727,7 @@ static void recalcData_view3d(TransInfo *t) DAG_id_tag_update(t->obedit->data, 0); /* sets recalc flags */ EDBM_RecalcNormals(em); - BMEdit_RecalcTesselation(em); + BMEdit_RecalcTessellation(em); } else if(t->obedit->type==OB_ARMATURE) { /* no recalc flag, does pose */ bArmature *arm= t->obedit->data; diff --git a/source/blender/editors/util/undo.c b/source/blender/editors/util/undo.c index 6ab68d2261e..d3049e97f9e 100644 --- a/source/blender/editors/util/undo.c +++ b/source/blender/editors/util/undo.c @@ -95,7 +95,7 @@ void ED_undo_push(bContext *C, const char *str) if (U.undosteps == 0) { if (obedit->type == OB_MESH) { Mesh *me= obedit->data; - BMEdit_RecalcTesselation(me->edit_btmesh); + BMEdit_RecalcTessellation(me->edit_btmesh); } } diff --git a/source/blender/editors/uvedit/uvedit_smart_stitch.c b/source/blender/editors/uvedit/uvedit_smart_stitch.c index 6196e684842..c7750fd516b 100644 --- a/source/blender/editors/uvedit/uvedit_smart_stitch.c +++ b/source/blender/editors/uvedit/uvedit_smart_stitch.c @@ -1174,7 +1174,7 @@ static int stitch_init(bContext *C, wmOperator *op) } } - /***** initialise static island preview data *****/ + /***** initialize static island preview data *****/ state->tris_per_island = MEM_mallocN(sizeof(*state->tris_per_island)*state->element_map->totalIslands, "stitch island tris"); diff --git a/source/blender/gpu/intern/gpu_extensions.c b/source/blender/gpu/intern/gpu_extensions.c index dfbb243aa7a..8129b27a66e 100644 --- a/source/blender/gpu/intern/gpu_extensions.c +++ b/source/blender/gpu/intern/gpu_extensions.c @@ -179,7 +179,7 @@ void GPU_extensions_init(void) GG.npotdisabled = 1; } - /* make sure double side isn't used by defautl and only getting enabled in places where it's + /* make sure double side isn't used by default and only getting enabled in places where it's * really needed to prevent different unexpected behaviors like with intel gme965 card (sergey) */ glLightModeli(GL_LIGHT_MODEL_TWO_SIDE, GL_FALSE); diff --git a/source/blender/ikplugin/intern/itasc_plugin.cpp b/source/blender/ikplugin/intern/itasc_plugin.cpp index 51f68d819d4..42a3aace775 100644 --- a/source/blender/ikplugin/intern/itasc_plugin.cpp +++ b/source/blender/ikplugin/intern/itasc_plugin.cpp @@ -268,7 +268,7 @@ static int initialize_chain(Object *ob, bPoseChannel *pchan_tip, bConstraint *co if (curchan->iktree.first != NULL) // Oh oh, there is already a chain starting from this channel and our chain is longer... - // Should handle this by moving the previous chain up to the begining of our chain + // Should handle this by moving the previous chain up to the beginning of our chain // For now we just stop here break; } diff --git a/source/blender/imbuf/IMB_imbuf.h b/source/blender/imbuf/IMB_imbuf.h index ee1580a3135..c96b0509a27 100644 --- a/source/blender/imbuf/IMB_imbuf.h +++ b/source/blender/imbuf/IMB_imbuf.h @@ -30,23 +30,22 @@ */ /** - * @file IMB_imbuf.h - * @brief IMage Buffer module. + * \brief IMage Buffer module. * * This module offers import/export of several graphical file formats. - * @ingroup imbuf + * \ingroup imbuf * - * @page IMB Imbuf module external interface + * \page IMB Imbuf module external interface * * - * @section about About the IMB module + * \section about About the IMB module * * External interface of the IMage Buffer module. This module offers * import/export of several graphical file formats. It offers the * ImBuf type as a common structure to refer to different graphical * file formats, and to enable a uniform way of handling them. * - * @section issues Known issues with IMB + * \section issues Known issues with IMB * * - imbuf is written in C. * - Endianness issues are dealt with internally. @@ -56,7 +55,7 @@ * amiga and Irix are present. A 'posix-compliancy-patch' * provides the interface to windows. * - * @section dependencies Dependencies + * \section dependencies Dependencies * * IMB needs: * - \ref DNA module @@ -73,51 +72,51 @@ /** * - * @attention defined in ??? + * \attention defined in ??? */ struct ImBuf; /** * - * @attention defined in ??? + * \attention defined in ??? */ struct anim; /** * - * @attention Defined in allocimbuf.c + * \attention Defined in allocimbuf.c */ void IMB_init(void); void IMB_exit(void); /** * - * @attention Defined in readimage.c + * \attention Defined in readimage.c */ struct ImBuf *IMB_ibImageFromMemory(unsigned char *mem, size_t size, int flags, const char *descr); /** * - * @attention Defined in readimage.c + * \attention Defined in readimage.c */ struct ImBuf *IMB_testiffname(const char *filepath, int flags); /** * - * @attention Defined in readimage.c + * \attention Defined in readimage.c */ struct ImBuf *IMB_loadiffname(const char *filepath, int flags); /** * - * @attention Defined in allocimbuf.c + * \attention Defined in allocimbuf.c */ void IMB_freeImBuf(struct ImBuf *ibuf); /** * - * @attention Defined in allocimbuf.c + * \attention Defined in allocimbuf.c */ struct ImBuf *IMB_allocImBuf(unsigned int x, unsigned int y, unsigned char d, unsigned int flags); @@ -128,7 +127,7 @@ struct ImBuf *IMB_allocImBuf(unsigned int x, unsigned int y, * (to delete an imbuf you have to call freeImBuf as many times as it * is referenced) * - * @attention Defined in allocimbuf.c + * \attention Defined in allocimbuf.c */ void IMB_refImBuf(struct ImBuf *ibuf); @@ -136,20 +135,20 @@ struct ImBuf * IMB_makeSingleUser(struct ImBuf *ibuf); /** * - * @attention Defined in allocimbuf.c + * \attention Defined in allocimbuf.c */ struct ImBuf *IMB_dupImBuf(struct ImBuf *ibuf1); /** * - * @attention Defined in allocimbuf.c + * \attention Defined in allocimbuf.c */ short addzbufImBuf(struct ImBuf *ibuf); short addzbuffloatImBuf(struct ImBuf *ibuf); /** * - * @attention Defined in rectop.c + * \attention Defined in rectop.c */ typedef enum IMB_BlendMode { @@ -181,7 +180,7 @@ void IMB_rectblend(struct ImBuf *dbuf, struct ImBuf *sbuf, int destx, /** * - * @attention Defined in indexer.c + * \attention Defined in indexer.c */ typedef enum IMB_Timecode_Type { @@ -231,7 +230,7 @@ void IMB_anim_index_rebuild(struct IndexBuildContext *context, void IMB_anim_index_rebuild_finish(struct IndexBuildContext *context, short stop); /** - * Return the length (in frames) of the given @a anim. + * Return the length (in frames) of the given \a anim. */ int IMB_anim_get_duration(struct anim *anim, IMB_Timecode_Type tc); @@ -245,7 +244,7 @@ int IMB_anim_get_fps(struct anim * anim, /** * - * @attention Defined in anim_movie.c + * \attention Defined in anim_movie.c */ struct anim *IMB_open_anim(const char *name, int ib_flags, int streamindex); void IMB_close_anim(struct anim *anim); @@ -254,7 +253,7 @@ void IMB_close_anim_proxies(struct anim *anim); /** * - * @attention Defined in anim_movie.c + * \attention Defined in anim_movie.c */ int ismovie(const char *filepath); @@ -263,7 +262,7 @@ int IMB_anim_get_preseek(struct anim *anim); /** * - * @attention Defined in anim_movie.c + * \attention Defined in anim_movie.c */ struct ImBuf *IMB_anim_absolute( @@ -273,20 +272,20 @@ struct ImBuf *IMB_anim_absolute( /** * - * @attention Defined in anim_movie.c + * \attention Defined in anim_movie.c * fetches a define previewframe, usually half way into the movie */ struct ImBuf *IMB_anim_previewframe(struct anim *anim); /** * - * @attention Defined in anim_movie.c + * \attention Defined in anim_movie.c */ void IMB_free_anim(struct anim *anim); /** * - * @attention Defined in filter.c + * \attention Defined in filter.c */ #define FILTER_MASK_NULL 0 @@ -304,7 +303,7 @@ struct ImBuf *IMB_getmipmap(struct ImBuf *ibuf, int level); /** * - * @attention Defined in cache.c + * \attention Defined in cache.c */ void IMB_tile_cache_params(int totthread, int maxmem); @@ -313,55 +312,55 @@ void IMB_tiles_to_rect(struct ImBuf *ibuf); /** * - * @attention Defined in filter.c + * \attention Defined in filter.c */ void IMB_filtery(struct ImBuf *ibuf); /** * - * @attention Defined in scaling.c + * \attention Defined in scaling.c */ struct ImBuf *IMB_onehalf(struct ImBuf *ibuf1); /** * - * @attention Defined in scaling.c + * \attention Defined in scaling.c */ struct ImBuf *IMB_scaleImBuf(struct ImBuf *ibuf, unsigned int newx, unsigned int newy); /** * - * @attention Defined in scaling.c + * \attention Defined in scaling.c */ struct ImBuf *IMB_scalefastImBuf(struct ImBuf *ibuf, unsigned int newx, unsigned int newy); /** * - * @attention Defined in writeimage.c + * \attention Defined in writeimage.c */ short IMB_saveiff(struct ImBuf *ibuf, const char *filepath, int flags); /** * - * @attention Defined in util.c + * \attention Defined in util.c */ int IMB_ispic(const char *name); /** * - * @attention Defined in util.c + * \attention Defined in util.c */ int IMB_isanim(const char *name); /** * - * @attention Defined in util.c + * \attention Defined in util.c */ int imb_get_anim_type(const char *name); /** * - * @attention Defined in divers.c + * \attention Defined in divers.c */ void IMB_de_interlace(struct ImBuf *ibuf); void IMB_interlace(struct ImBuf *ibuf); @@ -397,13 +396,13 @@ void IMB_buffer_float_clamp(float *buf, int width, int height); * Change the ordering of the color bytes pointed to by rect from * rgba to abgr. size * 4 color bytes are reordered. * - * @attention Defined in imageprocess.c + * \attention Defined in imageprocess.c */ void IMB_convert_rgba_to_abgr(struct ImBuf *ibuf); /** * - * @attention defined in imageprocess.c + * \attention defined in imageprocess.c */ void bicubic_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout); void neareast_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout); @@ -416,51 +415,51 @@ void bilinear_interpolation_color_wrap(struct ImBuf *in, unsigned char *col, flo /** * - * @attention defined in readimage.c - * @deprecated Only here for backwards compatibility of the - * @deprecated plugin system. + * \attention defined in readimage.c + * \deprecated Only here for backwards compatibility of the + * \deprecated plugin system. */ struct ImBuf *IMB_loadifffile(int file, int flags, const char *descr); /** * - * @attention defined in scaling.c + * \attention defined in scaling.c */ struct ImBuf *IMB_half_x(struct ImBuf *ibuf1); /** * - * @attention defined in scaling.c + * \attention defined in scaling.c */ struct ImBuf *IMB_double_fast_x(struct ImBuf *ibuf1); /** * - * @attention defined in scaling.c + * \attention defined in scaling.c */ struct ImBuf *IMB_double_x(struct ImBuf *ibuf1); /** * - * @attention defined in scaling.c + * \attention defined in scaling.c */ struct ImBuf *IMB_half_y(struct ImBuf *ibuf1); /** * - * @attention defined in scaling.c + * \attention defined in scaling.c */ struct ImBuf *IMB_double_fast_y(struct ImBuf *ibuf1); /** * - * @attention defined in scaling.c + * \attention defined in scaling.c */ struct ImBuf *IMB_double_y(struct ImBuf *ibuf1); /** * - * @attention Defined in rotate.c + * \attention Defined in rotate.c */ void IMB_flipx(struct ImBuf *ibuf); void IMB_flipy(struct ImBuf *ibuf); @@ -471,14 +470,14 @@ void IMB_premultiply_alpha(struct ImBuf *ibuf); /** * - * @attention Defined in allocimbuf.c + * \attention Defined in allocimbuf.c */ void IMB_freezbufImBuf(struct ImBuf *ibuf); void IMB_freezbuffloatImBuf(struct ImBuf *ibuf); /** * - * @attention Defined in rectop.c + * \attention Defined in rectop.c */ void IMB_rectfill(struct ImBuf *drect, const float col[4]); void IMB_rectfill_area(struct ImBuf *ibuf, float *col, int x1, int y1, int x2, int y2); diff --git a/source/blender/imbuf/intern/IMB_metadata.h b/source/blender/imbuf/intern/IMB_metadata.h index 3ae1015d6af..8211896b185 100644 --- a/source/blender/imbuf/intern/IMB_metadata.h +++ b/source/blender/imbuf/intern/IMB_metadata.h @@ -55,28 +55,28 @@ typedef struct ImMetaData { void IMB_metadata_free(struct ImBuf* img); /** read the field from the image info into the field - * @param img - the ImBuf that contains the image data - * @param key - the key of the field - * @param value - the data in the field, first one found with key is returned, + * \param img - the ImBuf that contains the image data + * \param key - the key of the field + * \param value - the data in the field, first one found with key is returned, memory has to be allocated by user. - * @param len - length of value buffer allocated by user. - * @return - 1 (true) if ImageInfo present and value for the key found, 0 (false) otherwise + * \param len - length of value buffer allocated by user. + * \return - 1 (true) if ImageInfo present and value for the key found, 0 (false) otherwise */ int IMB_metadata_get_field(struct ImBuf* img, const char* key, char* value, int len); /** set user data in the ImMetaData struct, which has to be allocated with IMB_metadata_create * before calling this function. - * @param img - the ImBuf that contains the image data - * @param key - the key of the field - * @param value - the data to be written to the field. zero terminated string - * @return - 1 (true) if ImageInfo present, 0 (false) otherwise + * \param img - the ImBuf that contains the image data + * \param key - the key of the field + * \param value - the data to be written to the field. zero terminated string + * \return - 1 (true) if ImageInfo present, 0 (false) otherwise */ int IMB_metadata_add_field(struct ImBuf* img, const char* key, const char* value); /** delete the key/field par in the ImMetaData struct. - * @param img - the ImBuf that contains the image data - * @param key - the key of the field - * @return - 1 (true) if delete the key/field, 0 (false) otherwise + * \param img - the ImBuf that contains the image data + * \param key - the key of the field + * \return - 1 (true) if delete the key/field, 0 (false) otherwise */ int IMB_metadata_del_field(struct ImBuf *img, const char *key); diff --git a/source/blender/imbuf/intern/dds/PixelFormat.h b/source/blender/imbuf/intern/dds/PixelFormat.h index 9add62c4616..3c5cb34812c 100644 --- a/source/blender/imbuf/intern/dds/PixelFormat.h +++ b/source/blender/imbuf/intern/dds/PixelFormat.h @@ -63,7 +63,7 @@ namespace PixelFormat { - // Convert component @a c having @a inbits to the returned value having @a outbits. + // Convert component \a c having \a inbits to the returned value having \a outbits. inline uint convert(uint c, uint inbits, uint outbits) { if (inbits == 0) diff --git a/source/blender/imbuf/intern/imbuf_cocoa.m b/source/blender/imbuf/intern/imbuf_cocoa.m index b79b1358ec2..db7f93423cb 100644 --- a/source/blender/imbuf/intern/imbuf_cocoa.m +++ b/source/blender/imbuf/intern/imbuf_cocoa.m @@ -53,12 +53,12 @@ * Loads any Core Graphics supported type * Currently is : TIFF, BMP, JPEG, GIF, PNG, DIB, ICO, and various RAW formats * - * @param mem: Memory containing the bitmap image - * @param size: Size of the mem buffer. - * @param flags: If flags has IB_test set then the file is not actually loaded, + * \param mem: Memory containing the bitmap image + * \param size: Size of the mem buffer. + * \param flags: If flags has IB_test set then the file is not actually loaded, * but all other operations take place. * - * @return: A newly allocated ImBuf structure if successful, otherwise NULL. + * \return: A newly allocated ImBuf structure if successful, otherwise NULL. */ struct ImBuf *imb_cocoaLoadImage(unsigned char *mem, int size, int flags) { @@ -197,11 +197,11 @@ struct ImBuf *imb_cocoaLoadImage(unsigned char *mem, int size, int flags) * * Accepted formats: TIFF, GIF, BMP, PNG, JPEG, JPEG2000 * - * @param ibuf: Image buffer. - * @param name: Name of the image file to create. - * @param flags: Currently largely ignored. + * \param ibuf: Image buffer. + * \param name: Name of the image file to create. + * \param flags: Currently largely ignored. * - * @return: 1 if the function is successful, 0 on failure. + * \return: 1 if the function is successful, 0 on failure. */ #define FTOUSHORT(val) ((val >= 1.0f-0.5f/65535)? 65535: (val <= 0.0f)? 0: (unsigned short)(val*65535.0f + 0.5f)) diff --git a/source/blender/imbuf/intern/openexr/openexr_api.h b/source/blender/imbuf/intern/openexr/openexr_api.h index 2b3a17ba47d..0d51461c2e8 100644 --- a/source/blender/imbuf/intern/openexr/openexr_api.h +++ b/source/blender/imbuf/intern/openexr/openexr_api.h @@ -41,7 +41,7 @@ extern "C" { /** * Test presence of OpenEXR file. - * @param mem pointer to loaded OpenEXR bitstream + * \param mem pointer to loaded OpenEXR bitstream */ int imb_is_a_openexr (unsigned char *mem); diff --git a/source/blender/imbuf/intern/tiff.c b/source/blender/imbuf/intern/tiff.c index 6fe2a3b8bc2..afc64e1a528 100644 --- a/source/blender/imbuf/intern/tiff.c +++ b/source/blender/imbuf/intern/tiff.c @@ -113,11 +113,11 @@ static int imb_tiff_DummyMapProc(thandle_t fd, tdata_t* pbase, toff_t* psize) /** * Reads data from an in-memory TIFF file. * - * @param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile). - * @param data: Buffer to contain data (treat as void*). - * @param n: Number of bytes to read. + * \param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile). + * \param data: Buffer to contain data (treat as void*). + * \param n: Number of bytes to read. * - * @return: Number of bytes actually read. + * \return: Number of bytes actually read. * 0 = EOF. */ static tsize_t imb_tiff_ReadProc(thandle_t handle, tdata_t data, tsize_t n) @@ -177,15 +177,15 @@ static tsize_t imb_tiff_WriteProc(thandle_t handle, tdata_t data, tsize_t n) /** * Seeks to a new location in an in-memory TIFF file. * - * @param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile). - * @param ofs: Offset value (interpreted according to whence below). - * @param whence: This can be one of three values: + * \param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile). + * \param ofs: Offset value (interpreted according to whence below). + * \param whence: This can be one of three values: * SEEK_SET - The offset is set to ofs bytes. * SEEK_CUR - The offset is set to its current location plus ofs bytes. * SEEK_END - (This is unsupported and will return -1, indicating an * error). * - * @return: Resulting offset location within the file, measured in bytes from + * \return: Resulting offset location within the file, measured in bytes from * the beginning of the file. (-1) indicates an error. */ static toff_t imb_tiff_SeekProc(thandle_t handle, toff_t ofs, int whence) @@ -231,9 +231,9 @@ static toff_t imb_tiff_SeekProc(thandle_t handle, toff_t ofs, int whence) * are made to access the file after that point. However, no such * attempts should ever be made (in theory). * - * @param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile). + * \param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile). * - * @return: 0 + * \return: 0 */ static int imb_tiff_CloseProc(thandle_t handle) { @@ -259,7 +259,7 @@ static int imb_tiff_CloseProc(thandle_t handle) /** * Returns the size of an in-memory TIFF file in bytes. * - * @return: Size of file (in bytes). + * \return: Size of file (in bytes). */ static toff_t imb_tiff_SizeProc(thandle_t handle) { @@ -495,12 +495,12 @@ void imb_inittiff(void) * Loads a TIFF file. * * - * @param mem: Memory containing the TIFF file. - * @param size: Size of the mem buffer. - * @param flags: If flags has IB_test set then the file is not actually loaded, + * \param mem: Memory containing the TIFF file. + * \param size: Size of the mem buffer. + * \param flags: If flags has IB_test set then the file is not actually loaded, * but all other operations take place. * - * @return: A newly allocated ImBuf structure if successful, otherwise NULL. + * \return: A newly allocated ImBuf structure if successful, otherwise NULL. */ ImBuf *imb_loadtiff(unsigned char *mem, size_t size, int flags) { @@ -661,11 +661,11 @@ void imb_loadtiletiff(ImBuf *ibuf, unsigned char *mem, size_t size, int tx, int * Blender by setting "Premul" alpha handling. Other alpha conventions are * not strictly correct, but are permitted anyhow. * - * @param ibuf: Image buffer. - * @param name: Name of the TIFF file to create. - * @param flags: Currently largely ignored. + * \param ibuf: Image buffer. + * \param name: Name of the TIFF file to create. + * \param flags: Currently largely ignored. * - * @return: 1 if the function is successful, 0 on failure. + * \return: 1 if the function is successful, 0 on failure. */ int imb_savetiff(ImBuf *ibuf, const char *name, int flags) diff --git a/source/blender/makesdna/DNA_curve_types.h b/source/blender/makesdna/DNA_curve_types.h index d5b9477f7f6..e311b6dffea 100644 --- a/source/blender/makesdna/DNA_curve_types.h +++ b/source/blender/makesdna/DNA_curve_types.h @@ -125,7 +125,7 @@ typedef struct Nurb { short mat_nr; /* index into material list */ short hide, flag; short pntsu, pntsv; /* number of points in the U or V directions */ - short resolu, resolv; /* tesselation resolution in the U or V directions */ + short resolu, resolv; /* tessellation resolution in the U or V directions */ short orderu, orderv; short flagu, flagv; diff --git a/source/blender/makesdna/DNA_material_types.h b/source/blender/makesdna/DNA_material_types.h index b58ae921200..6416f3117dc 100644 --- a/source/blender/makesdna/DNA_material_types.h +++ b/source/blender/makesdna/DNA_material_types.h @@ -168,7 +168,7 @@ typedef struct Material { float sss_front, sss_back; short sss_flag, sss_preset; - int mapto_textured; /* render-time cache to optimise texture lookups */ + int mapto_textured; /* render-time cache to optimize texture lookups */ short shadowonly_flag; /* "shadowsonly" type */ short index; /* custom index for render passes */ diff --git a/source/blender/makesdna/DNA_mesh_types.h b/source/blender/makesdna/DNA_mesh_types.h index c6eeccadc62..9c20c33ce40 100644 --- a/source/blender/makesdna/DNA_mesh_types.h +++ b/source/blender/makesdna/DNA_mesh_types.h @@ -77,10 +77,10 @@ typedef struct Mesh { struct MLoopCol *mloopcol; /* END BMESH ONLY */ - /*mface stores the tesselation (triangulation) of the mesh, + /*mface stores the tessellation (triangulation) of the mesh, real faces are now stored in nface.*/ - struct MFace *mface; /* array of mesh object mode faces for tesselation */ - struct MTFace *mtface; /* store tesselation face UV's and texture here */ + struct MFace *mface; /* array of mesh object mode faces for tessellation */ + struct MTFace *mtface; /* store tessellation face UV's and texture here */ struct TFace *tface; /* depecrated, use mtface */ struct MVert *mvert; /* array of verts */ struct MEdge *medge; /* array of edges */ diff --git a/source/blender/makesdna/DNA_meshdata_types.h b/source/blender/makesdna/DNA_meshdata_types.h index 9f1dbcc1b86..be2a676778f 100644 --- a/source/blender/makesdna/DNA_meshdata_types.h +++ b/source/blender/makesdna/DNA_meshdata_types.h @@ -38,7 +38,7 @@ struct Bone; struct Image; -/*tesselation face, see MLoop/MPoly for the real face data*/ +/*tessellation face, see MLoop/MPoly for the real face data*/ typedef struct MFace { unsigned int v1, v2, v3, v4; short mat_nr; @@ -68,7 +68,7 @@ typedef struct MVert { char flag, bweight; } MVert; -/* tesselation vertex color data. +/* tessellation vertex color data. * at the moment alpha is abused for vertex painting * and not used for transparency, note that red and blue are swapped */ typedef struct MCol { @@ -76,7 +76,7 @@ typedef struct MCol { } MCol; /*new face structure, replaces MFace, which is now - only used for storing tesselations.*/ + only used for storing tessellations.*/ typedef struct MPoly { /* offset into loop array and number of loops in the face */ int loopstart; @@ -134,7 +134,7 @@ typedef struct MSelect { int type; /* EDITVERT/EDITEDGE/EDITFACE */ } MSelect; -/*tesselation uv face data*/ +/*tessellation uv face data*/ typedef struct MTFace { float uv[4][2]; struct Image *tpage; diff --git a/source/blender/makesdna/DNA_texture_types.h b/source/blender/makesdna/DNA_texture_types.h index d32e31bfeb4..c026c2018fd 100644 --- a/source/blender/makesdna/DNA_texture_types.h +++ b/source/blender/makesdna/DNA_texture_types.h @@ -97,9 +97,9 @@ typedef struct MTex { #ifndef DNA_USHORT_FIX #define DNA_USHORT_FIX /** - * @deprecated This typedef serves to avoid badly typed functions when - * @deprecated compiling while delivering a proper dna.c. Do not use - * @deprecated it in any case. + * \deprecated This typedef serves to avoid badly typed functions when + * \deprecated compiling while delivering a proper dna.c. Do not use + * \deprecated it in any case. */ typedef unsigned short dna_ushort_fix; #endif diff --git a/source/blender/makesrna/intern/rna_mesh_api.c b/source/blender/makesrna/intern/rna_mesh_api.c index 3eb08a91d19..988eaccadb2 100644 --- a/source/blender/makesrna/intern/rna_mesh_api.c +++ b/source/blender/makesrna/intern/rna_mesh_api.c @@ -67,7 +67,7 @@ void RNA_api_mesh(StructRNA *srna) func= RNA_def_function(srna, "update", "ED_mesh_update"); RNA_def_boolean(func, "calc_edges", 0, "Calculate Edges", "Force recalculation of edges"); - RNA_def_boolean(func, "calc_tessface", 0, "Calculate Tesselation", "Force recalculation of tesselation faces"); + RNA_def_boolean(func, "calc_tessface", 0, "Calculate Tessellation", "Force recalculation of tessellation faces"); RNA_def_function_flag(func, FUNC_USE_CONTEXT); func= RNA_def_function(srna, "unit_test_compare", "rna_Mesh_unit_test_compare"); diff --git a/source/blender/makesrna/intern/rna_scene.c b/source/blender/makesrna/intern/rna_scene.c index ea4ba6139d3..fa82320bc67 100644 --- a/source/blender/makesrna/intern/rna_scene.c +++ b/source/blender/makesrna/intern/rna_scene.c @@ -2393,7 +2393,7 @@ static void rna_def_scene_game_data(BlenderRNA *brna) RNA_def_property_ui_text(prop, "Dome Mode", "Dome physical configurations"); RNA_def_property_update(prop, NC_SCENE, NULL); - prop= RNA_def_property(srna, "dome_tesselation", PROP_INT, PROP_NONE); + prop= RNA_def_property(srna, "dome_tessellation", PROP_INT, PROP_NONE); RNA_def_property_int_sdna(prop, NULL, "dome.res"); RNA_def_property_ui_range(prop, 1, 8, 1, 1); RNA_def_property_ui_text(prop, "Tessellation", "Tessellation level - check the generated mesh in wireframe mode"); diff --git a/source/blender/nodes/shader/node_shader_tree.c b/source/blender/nodes/shader/node_shader_tree.c index b1e1989da86..e4f21a474c0 100644 --- a/source/blender/nodes/shader/node_shader_tree.c +++ b/source/blender/nodes/shader/node_shader_tree.c @@ -249,7 +249,7 @@ void ntreeShaderExecTree(bNodeTree *ntree, ShadeInput *shi, ShadeResult *shr) { ShaderCallData scd; /* - @note: preserve material from ShadeInput for material id, nodetree execs change it + \note: preserve material from ShadeInput for material id, nodetree execs change it fix for bug "[#28012] Mat ID messy with shader nodes" */ Material *mat = shi->mat; @@ -277,7 +277,7 @@ void ntreeShaderExecTree(bNodeTree *ntree, ShadeInput *shi, ShadeResult *shr) ntreeExecThreadNodes(exec, nts, &scd, shi->thread); ntreeReleaseThreadStack(nts); - // @note: set material back to preserved material + // \note: set material back to preserved material shi->mat = mat; /* better not allow negative for now */ if(shr->combined[0]<0.0f) shr->combined[0]= 0.0f; diff --git a/source/blender/render/intern/include/pixelshading.h b/source/blender/render/intern/include/pixelshading.h index 17032283540..c0adc36f3a3 100644 --- a/source/blender/render/intern/include/pixelshading.h +++ b/source/blender/render/intern/include/pixelshading.h @@ -46,7 +46,7 @@ * t[3] - type ZB_POLY or ZB_HALO * t[4] - max. distance * mask is pixel coverage in bits - * @return pointer to the object + * \return pointer to the object */ int shadeHaloFloat(HaloRen *har, float *col, int zz, diff --git a/source/blender/render/intern/include/shadbuf.h b/source/blender/render/intern/include/shadbuf.h index ddcfc555f7a..4b3595a009f 100644 --- a/source/blender/render/intern/include/shadbuf.h +++ b/source/blender/render/intern/include/shadbuf.h @@ -42,7 +42,7 @@ struct ObjectRen; /** * Calculates shadowbuffers for a vector of shadow-giving lamps - * @param lar The vector of lamps + * \param lar The vector of lamps */ void makeshadowbuf(struct Render *re, LampRen *lar); void freeshadowbuf(struct LampRen *lar); @@ -52,10 +52,10 @@ void threaded_makeshadowbufs(struct Render *re); /** * Determines the shadow factor for a face and lamp. There is some * communication with global variables here. - * @returns The shadow factors: 1.0 for no shadow, 0.0 for complete - * shadow. - * @param shb The shadowbuffer to find the shadow factor in. - * @param inp The inproduct between viewvector and ? + * \return The shadow factors: 1.0 for no shadow, 0.0 for complete + * shadow. + * \param shb The shadowbuffer to find the shadow factor in. + * \param inp The inproduct between viewvector and ? * */ float testshadowbuf(struct Render *re, struct ShadBuf *shb, const float rco[3], const float dxco[3], const float dyco[3], float inp, float mat_bias); diff --git a/source/blender/render/intern/source/convertblender.c b/source/blender/render/intern/source/convertblender.c index 30dc401da27..976c3707fd4 100644 --- a/source/blender/render/intern/source/convertblender.c +++ b/source/blender/render/intern/source/convertblender.c @@ -1591,7 +1591,7 @@ static int render_new_particle_system(Render *re, ObjectRen *obr, ParticleSystem if(part->ren_as==PART_DRAW_OB || part->ren_as==PART_DRAW_GR || part->ren_as==PART_DRAW_NOT) return 1; -/* 2. start initialising things */ +/* 2. start initializing things */ /* last possibility to bail out! */ psmd = psys_get_modifier(ob,psys); diff --git a/source/blender/render/intern/source/pixelshading.c b/source/blender/render/intern/source/pixelshading.c index 9746a6dbd86..223c56ef9d6 100644 --- a/source/blender/render/intern/source/pixelshading.c +++ b/source/blender/render/intern/source/pixelshading.c @@ -252,8 +252,8 @@ static void render_lighting_halo(HaloRen *har, float col_r[3]) /** * Converts a halo z-buffer value to distance from the camera's near plane - * @param z The z-buffer value to convert - * @return a distance from the camera's near plane in blender units + * \param z The z-buffer value to convert + * \return a distance from the camera's near plane in blender units */ static float haloZtoDist(int z) { @@ -271,13 +271,13 @@ static float haloZtoDist(int z) } /** - * @param col (float[4]) Store the rgb color here (with alpha) + * \param col (float[4]) Store the rgb color here (with alpha) * The alpha is used to blend the color to the background * color_new = (1-alpha)*color_background + color - * @param zz The current zbuffer value at the place of this pixel - * @param dist Distance of the pixel from the center of the halo squared. Given in pixels - * @param xn The x coordinate of the pixel relaticve to the center of the halo. given in pixels - * @param yn The y coordinate of the pixel relaticve to the center of the halo. given in pixels + * \param zz The current zbuffer value at the place of this pixel + * \param dist Distance of the pixel from the center of the halo squared. Given in pixels + * \param xn The x coordinate of the pixel relaticve to the center of the halo. given in pixels + * \param yn The y coordinate of the pixel relaticve to the center of the halo. given in pixels */ int shadeHaloFloat(HaloRen *har, float *col, int zz, float dist, float xn, float yn, short flarec) diff --git a/source/blender/render/intern/source/shadeinput.c b/source/blender/render/intern/source/shadeinput.c index 052f9769b4e..dd9e1df95cd 100644 --- a/source/blender/render/intern/source/shadeinput.c +++ b/source/blender/render/intern/source/shadeinput.c @@ -91,7 +91,7 @@ extern struct Render R; */ -/* initialise material variables in shadeinput, +/* initialize material variables in shadeinput, * doing inverse gamma correction where applicable */ void shade_input_init_material(ShadeInput *shi) { diff --git a/source/blender/render/intern/source/shadeoutput.c b/source/blender/render/intern/source/shadeoutput.c index 78420aa6ca8..115a913337f 100644 --- a/source/blender/render/intern/source/shadeoutput.c +++ b/source/blender/render/intern/source/shadeoutput.c @@ -1253,7 +1253,7 @@ static void shade_one_light(LampRen *lar, ShadeInput *shi, ShadeResult *shr, int /* only shadow lamps shouldn't affect shadow-less materials at all */ if ((lar->mode & LA_ONLYSHADOW) && (!(ma->mode & MA_SHADOW) || !(R.r.mode & R_SHADOW))) return; - /* optimisation, don't render fully black lamps */ + /* optimization, don't render fully black lamps */ if (!(lar->mode & LA_TEXTURE) && (lar->r + lar->g + lar->b == 0.0f)) return; diff --git a/source/blender/render/intern/source/voxeldata.c b/source/blender/render/intern/source/voxeldata.c index ce5561b3e34..ebcc2ce997f 100644 --- a/source/blender/render/intern/source/voxeldata.c +++ b/source/blender/render/intern/source/voxeldata.c @@ -155,7 +155,7 @@ static void load_frame_image_sequence(VoxelData *vd, Tex *tex) ima->source = IMA_SRC_SEQUENCE; iuser.framenr = 1 + iuser.offset; - /* find the first valid ibuf and use it to initialise the resolution of the data set */ + /* find the first valid ibuf and use it to initialize the resolution of the data set */ /* need to do this in advance so we know how much memory to allocate */ ibuf= BKE_image_get_ibuf(ima, &iuser); while (!ibuf && (iuser.framenr < iuser.frames)) { diff --git a/source/blender/render/intern/source/zbuf.c b/source/blender/render/intern/source/zbuf.c index e90047a4a9c..0727fd6fdd7 100644 --- a/source/blender/render/intern/source/zbuf.c +++ b/source/blender/render/intern/source/zbuf.c @@ -1032,9 +1032,9 @@ void zbufsinglewire(ZSpan *zspan, int obi, int zvlnr, const float ho1[4], const * This is one of the z buffer fill functions called in zbufclip() and * zbufwireclip(). * - * @param v1 [4 floats, world coordinates] first vertex - * @param v2 [4 floats, world coordinates] second vertex - * @param v3 [4 floats, world coordinates] third vertex + * \param v1 [4 floats, world coordinates] first vertex + * \param v2 [4 floats, world coordinates] second vertex + * \param v3 [4 floats, world coordinates] third vertex */ /* WATCH IT: zbuffillGLinv4 and zbuffillGL4 are identical except for a 2 lines, @@ -1285,9 +1285,9 @@ static void zbuffillGL4(ZSpan *zspan, int obi, int zvlnr, float *v1, float *v2, * This is one of the z buffer fill functions called in zbufclip() and * zbufwireclip(). * - * @param v1 [4 floats, world coordinates] first vertex - * @param v2 [4 floats, world coordinates] second vertex - * @param v3 [4 floats, world coordinates] third vertex + * \param v1 [4 floats, world coordinates] first vertex + * \param v2 [4 floats, world coordinates] second vertex + * \param v3 [4 floats, world coordinates] third vertex */ /* now: filling two Z values, the closest and 2nd closest */ @@ -1594,12 +1594,12 @@ void zspan_scanconvert(ZSpan *zspan, void *handle, float *v1, float *v2, float * * viewspace coordinates. labda = -1 means no clipping, labda in [0, * 1] means a clipping. * Note: uses globals. - * @param v1 start coordinate s - * @param v2 target coordinate t - * @param b1 - * @param b2 - * @param b3 - * @param a index for coordinate (x, y, or z) + * \param v1 start coordinate s + * \param v2 target coordinate t + * \param b1 + * \param b2 + * \param b3 + * \param a index for coordinate (x, y, or z) */ static void clippyra(float *labda, float *v1, float *v2, int *b2, int *b3, int a, float clipcrop) @@ -1652,11 +1652,11 @@ static void clippyra(float *labda, float *v1, float *v2, int *b2, int *b3, int a * vertex list of this face. * * - * @param v1 start coordinate s - * @param v2 target coordinate t - * @param b1 - * @param b2 - * @param clve vertex vector. + * \param v1 start coordinate s + * \param v2 target coordinate t + * \param b1 + * \param b2 + * \param clve vertex vector. */ static void makevertpyra(float *vez, float *labda, float **trias, float *v1, float *v2, int *b1, int *clve) diff --git a/source/gameengine/BlenderRoutines/KX_BlenderCanvas.h b/source/gameengine/BlenderRoutines/KX_BlenderCanvas.h index 0da5301ed5d..a9a12f5a9e0 100644 --- a/source/gameengine/BlenderRoutines/KX_BlenderCanvas.h +++ b/source/gameengine/BlenderRoutines/KX_BlenderCanvas.h @@ -65,7 +65,7 @@ private: public: /* Construct a new canvas. * - * @param area The Blender ARegion to run the game within. + * \param area The Blender ARegion to run the game within. */ KX_BlenderCanvas(struct wmWindow* win, class RAS_Rect &rect, struct ARegion* ar); ~KX_BlenderCanvas(); diff --git a/source/gameengine/Converter/BL_MeshDeformer.cpp b/source/gameengine/Converter/BL_MeshDeformer.cpp index c4e7fd993c4..4e5852a21c1 100644 --- a/source/gameengine/Converter/BL_MeshDeformer.cpp +++ b/source/gameengine/Converter/BL_MeshDeformer.cpp @@ -110,7 +110,7 @@ void BL_MeshDeformer::Relink(CTR_Map<class CTR_HashedPtr, void*>*map) } /** - * @warning This function is expensive! + * \warning This function is expensive! */ void BL_MeshDeformer::RecalcNormals() { diff --git a/source/gameengine/Expressions/ListValue.h b/source/gameengine/Expressions/ListValue.h index 26c11cccc7a..4446b40af16 100644 --- a/source/gameengine/Expressions/ListValue.h +++ b/source/gameengine/Expressions/ListValue.h @@ -34,7 +34,7 @@ public: void Configure(CValue* menuvalue); void Add(CValue* value); - /** @attention not implemented yet :( */ + /** \attention not implemented yet :( */ virtual CValue* Calc(VALUE_OPERATOR op,CValue *val); virtual CValue* CalcFinal(VALUE_DATA_TYPE dtype, VALUE_OPERATOR op, diff --git a/source/gameengine/Expressions/PyObjectPlus.cpp b/source/gameengine/Expressions/PyObjectPlus.cpp index 9f3b62b34d8..e772aec28e3 100644 --- a/source/gameengine/Expressions/PyObjectPlus.cpp +++ b/source/gameengine/Expressions/PyObjectPlus.cpp @@ -217,7 +217,7 @@ PyObject * PyObjectPlus::py_base_new(PyTypeObject *type, PyObject *args, PyObjec } /** - * @param self A PyObjectPlus_Proxy + * \param self A PyObjectPlus_Proxy */ void PyObjectPlus::py_base_dealloc(PyObject *self) // python wrapper { diff --git a/source/gameengine/Expressions/Value.h b/source/gameengine/Expressions/Value.h index 64d7496a4e5..3a81ec05d5b 100644 --- a/source/gameengine/Expressions/Value.h +++ b/source/gameengine/Expressions/Value.h @@ -316,7 +316,7 @@ public: virtual CValue* FindIdentifier(const STR_String& identifiername); /** Set the wireframe color of this value depending on the CSG * operator type <op> - * @attention: not implemented */ + * \attention: not implemented */ virtual void SetColorOperator(VALUE_OPERATOR op); virtual const STR_String & GetText() = 0; @@ -327,7 +327,7 @@ public: virtual STR_String& GetName() = 0; // Retrieve the name of the value virtual void SetName(const char *name) = 0; // Set the name of the value /** Sets the value to this cvalue. - * @attention this particular function should never be called. Why not abstract? */ + * \attention this particular function should never be called. Why not abstract? */ virtual void SetValue(CValue* newval); virtual CValue* GetReplica() =0; virtual void ProcessReplica(); diff --git a/source/gameengine/GameLogic/SCA_ISensor.h b/source/gameengine/GameLogic/SCA_ISensor.h index 8a7a29ef5b9..3bb29f3f0a2 100644 --- a/source/gameengine/GameLogic/SCA_ISensor.h +++ b/source/gameengine/GameLogic/SCA_ISensor.h @@ -119,9 +119,9 @@ public: virtual CValue* GetReplica()=0; /** Set parameters for the pulsing behavior. - * @param posmode Trigger positive pulses? - * @param negmode Trigger negative pulses? - * @param freq Frequency to use when doing pulsing. + * \param posmode Trigger positive pulses? + * \param negmode Trigger negative pulses? + * \param freq Frequency to use when doing pulsing. */ void SetPulseMode(bool posmode, bool negmode, diff --git a/source/gameengine/GameLogic/SCA_JoystickSensor.h b/source/gameengine/GameLogic/SCA_JoystickSensor.h index db34ce4cc15..eecbf2c4183 100644 --- a/source/gameengine/GameLogic/SCA_JoystickSensor.h +++ b/source/gameengine/GameLogic/SCA_JoystickSensor.h @@ -65,7 +65,7 @@ class SCA_JoystickSensor :public SCA_ISensor */ int m_hatf; /** - * The threshold value the axis acts opon + * The threshold value the axis acts upon */ int m_precision; /** diff --git a/source/gameengine/GameLogic/SCA_RandomActuator.cpp b/source/gameengine/GameLogic/SCA_RandomActuator.cpp index 59925f44040..0034b5b3f54 100644 --- a/source/gameengine/GameLogic/SCA_RandomActuator.cpp +++ b/source/gameengine/GameLogic/SCA_RandomActuator.cpp @@ -404,7 +404,7 @@ KX_PYMETHODDEF_DOC_VARARGS(SCA_RandomActuator, setBoolConst, /* 12. setBoolUniform, */ KX_PYMETHODDEF_DOC_NOARGS(SCA_RandomActuator, setBoolUniform, "setBoolUniform()\n" -"\tSet this generator to produce true and false, each with 50%% chance of occuring\n") +"\tSet this generator to produce true and false, each with 50%% chance of occurring\n") { /* no args */ m_distribution = KX_RANDOMACT_BOOL_UNIFORM; diff --git a/source/gameengine/GamePlayer/common/GPC_Canvas.h b/source/gameengine/GamePlayer/common/GPC_Canvas.h index 28105a8cdd8..cd2bc7e374e 100644 --- a/source/gameengine/GamePlayer/common/GPC_Canvas.h +++ b/source/gameengine/GamePlayer/common/GPC_Canvas.h @@ -106,7 +106,7 @@ public: virtual void ResizeWindow(int width, int height){}; /** - * @section Methods inherited from abstract base class RAS_ICanvas. + * \section Methods inherited from abstract base class RAS_ICanvas. */ int @@ -157,7 +157,7 @@ public: void ClearColor(float r, float g, float b, float a); /** - * @section Methods inherited from abstract base class RAS_ICanvas. + * \section Methods inherited from abstract base class RAS_ICanvas. * Semantics are not yet honored. */ @@ -176,20 +176,20 @@ public: void ClearBuffer(int type); /** - * @section Services provided by this class. + * \section Services provided by this class. */ /** * Enables display of a banner. * The image data is copied inside. - * @param bannerWidth Display width of the banner. - * @param bannerHeight Display height of the banner. - * @param imageWidth Width of the banner image in pixels. - * @param imageHeight Height of the banner image in pixels. - * @param imageData Pointer to the pixels of the image to display. - * @param alignment Where the banner will be positioned on the canvas. - * @param enabled Whether the banner will be displayed initially. - * @return A banner id. + * \param bannerWidth Display width of the banner. + * \param bannerHeight Display height of the banner. + * \param imageWidth Width of the banner image in pixels. + * \param imageHeight Height of the banner image in pixels. + * \param imageData Pointer to the pixels of the image to display. + * \param alignment Where the banner will be positioned on the canvas. + * \param enabled Whether the banner will be displayed initially. + * \return A banner id. */ TBannerId AddBanner( unsigned int bannerWidth, unsigned int bannerHeight, @@ -199,7 +199,7 @@ public: /** * Disposes a banner. - * @param id Banner to be disposed. + * \param id Banner to be disposed. */ void DisposeBanner(TBannerId id); @@ -210,21 +210,21 @@ public: /** * Enables or disables display of a banner. - * @param id Banner id of the banner to be enabled/disabled. - * @param enabled New state of the banner. + * \param id Banner id of the banner to be enabled/disabled. + * \param enabled New state of the banner. */ void SetBannerEnabled(TBannerId id, bool enabled = true); /** * Enables or disables display of all banners. - * @param enabled New state of the banners. + * \param enabled New state of the banners. */ void SetBannerDisplayEnabled(bool enabled = true); protected: /** * Disposes a banner. - * @param it Banner to be disposed. + * \param it Banner to be disposed. */ void DisposeBanner(TBannerData& banner); diff --git a/source/gameengine/GamePlayer/common/GPC_KeyboardDevice.h b/source/gameengine/GamePlayer/common/GPC_KeyboardDevice.h index ba4213b190c..63e051dd1d4 100644 --- a/source/gameengine/GamePlayer/common/GPC_KeyboardDevice.h +++ b/source/gameengine/GamePlayer/common/GPC_KeyboardDevice.h @@ -45,7 +45,7 @@ * System independent implementation of SCA_IInputDevice. * System dependent keyboard devices need only to inherit this class * and fill the m_reverseKeyTranslateTable key translation map. - * @see SCA_IInputDevice + * \see SCA_IInputDevice */ class GPC_KeyboardDevice : public SCA_IInputDevice diff --git a/source/gameengine/GamePlayer/common/GPC_MouseDevice.h b/source/gameengine/GamePlayer/common/GPC_MouseDevice.h index c5576d1d234..2db1b1ec34c 100644 --- a/source/gameengine/GamePlayer/common/GPC_MouseDevice.h +++ b/source/gameengine/GamePlayer/common/GPC_MouseDevice.h @@ -41,7 +41,7 @@ /** * Generic Ketsji mouse device. - * @see SCA_IInputDevice + * \see SCA_IInputDevice */ class GPC_MouseDevice : public SCA_IInputDevice { @@ -65,39 +65,39 @@ public: /** * Call this routine to update the mouse device when a button state changes. - * @param button Which button state changes. - * @param isDown The new state of the button. - * @param x Position x-coordinate of the cursor at the time of the state change. - * @param y Position y-coordinate of the cursor at the time of the state change. - * @return Indication as to whether the event was processed. + * \param button Which button state changes. + * \param isDown The new state of the button. + * \param x Position x-coordinate of the cursor at the time of the state change. + * \param y Position y-coordinate of the cursor at the time of the state change. + * \return Indication as to whether the event was processed. */ virtual bool ConvertButtonEvent(TButtonId button, bool isDown); /** * Call this routine to update the mouse device when a button state and * cursor position changes at the same time (e.g. in Win32 messages). - * @param button Which button state changes. - * @param isDown The new state of the button. - * @param x Position x-coordinate of the cursor at the time of the state change. - * @param y Position y-coordinate of the cursor at the time of the state change. - * @return Indication as to whether the event was processed. + * \param button Which button state changes. + * \param isDown The new state of the button. + * \param x Position x-coordinate of the cursor at the time of the state change. + * \param y Position y-coordinate of the cursor at the time of the state change. + * \return Indication as to whether the event was processed. */ virtual bool ConvertButtonEvent(TButtonId button, bool isDown, int x, int y); /** * Call this routine to update the mouse device when the cursor has moved. - * @param x Position x-coordinate of the cursor. - * @param y Position y-coordinate of the cursor. - * @return Indication as to whether the event was processed. + * \param x Position x-coordinate of the cursor. + * \param y Position y-coordinate of the cursor. + * \return Indication as to whether the event was processed. */ virtual bool ConvertMoveEvent(int x, int y); protected: /** * This routine converts a single mouse event to a Ketsji mouse event. - * @param kxevent Ketsji event code. - * @param eventval Value for this event. - * @return Indication as to whether the event was processed. + * \param kxevent Ketsji event code. + * \param eventval Value for this event. + * \return Indication as to whether the event was processed. */ virtual bool ConvertEvent(KX_EnumInputs kxevent, int eventval); }; diff --git a/source/gameengine/GamePlayer/common/GPC_RawImage.h b/source/gameengine/GamePlayer/common/GPC_RawImage.h index 86a5feb8ea3..4d3f45597f8 100644 --- a/source/gameengine/GamePlayer/common/GPC_RawImage.h +++ b/source/gameengine/GamePlayer/common/GPC_RawImage.h @@ -52,16 +52,16 @@ public: /** * Loads the image form the resource into memory. * Converts size of the image and places it with given alignment. - * @param hInstApp The application's instance (location of the resources). - * @param lpName Name of the resource. - * @param lpType Type of the resource. - * @param srcWidth The width of the resource image. - * @param srcHeight The height of the resource image. - * @param width The width of the image created. - * @param height The height of the image created. - * @param alignment How the resource image is located in the image created. - * @param offsetX Amount of horizontal offset applied to the resource image. - * @param offsetY Amount of vertical offset applied to the resource image. + * \param hInstApp The application's instance (location of the resources). + * \param lpName Name of the resource. + * \param lpType Type of the resource. + * \param srcWidth The width of the resource image. + * \param srcHeight The height of the resource image. + * \param width The width of the image created. + * \param height The height of the image created. + * \param alignment How the resource image is located in the image created. + * \param offsetX Amount of horizontal offset applied to the resource image. + * \param offsetY Amount of vertical offset applied to the resource image. */ virtual bool Load(const char *srcName, int destWidth, int destHeight, @@ -70,7 +70,7 @@ public: /** * Returns the width of the image. - * @return The width of the image. + * \return The width of the image. */ virtual int Width() const { @@ -79,7 +79,7 @@ public: /** * Returns the height of the image. - * @return The height of the image. + * \return The height of the image. */ virtual int Height() const { @@ -88,7 +88,7 @@ public: /** * Returns a pointer to the data loaded from the resource. - * @return A pointer to the data loaded from the resource. + * \return A pointer to the data loaded from the resource. */ virtual unsigned char *Data() const { @@ -97,7 +97,7 @@ public: /** * Returns the size of the data loaded from the resource. - * @return The size of the loaded from the resource. + * \return The size of the loaded from the resource. */ virtual int DataSize() const { diff --git a/source/gameengine/GamePlayer/common/GPC_RenderTools.h b/source/gameengine/GamePlayer/common/GPC_RenderTools.h index 54bf45fc74b..166a931beab 100644 --- a/source/gameengine/GamePlayer/common/GPC_RenderTools.h +++ b/source/gameengine/GamePlayer/common/GPC_RenderTools.h @@ -77,7 +77,7 @@ public: float* color, double* mat, float aspect); - /* @attention mode is ignored here */ + /* \attention mode is ignored here */ void RenderText2D(RAS_TEXT_RENDER_MODE mode, const char* text, int xco, diff --git a/source/gameengine/GamePlayer/ghost/GPG_KeyboardDevice.h b/source/gameengine/GamePlayer/ghost/GPG_KeyboardDevice.h index 57fd0694ec0..8d72a621b6a 100644 --- a/source/gameengine/GamePlayer/ghost/GPG_KeyboardDevice.h +++ b/source/gameengine/GamePlayer/ghost/GPG_KeyboardDevice.h @@ -44,7 +44,7 @@ * GHOST implementation of GPC_KeyboardDevice. * The contructor fills the keyboard code translation map. * Base class GPC_KeyboardDevice does the rest. - * @see SCA_IInputDevice + * \see SCA_IInputDevice */ class GPG_KeyboardDevice : public GPC_KeyboardDevice { diff --git a/source/gameengine/Ketsji/KX_Camera.h b/source/gameengine/Ketsji/KX_Camera.h index 082d363fed6..38fc170e371 100644 --- a/source/gameengine/Ketsji/KX_Camera.h +++ b/source/gameengine/Ketsji/KX_Camera.h @@ -191,7 +191,7 @@ public: void InvalidateProjectionMatrix(bool valid = false); /** Gets the modelview matrix that is used by the rasterizer. - * @warning If the Camera is a dynamic object then this method may return garbage. Use GetCameraToWorld() instead. + * \warning If the Camera is a dynamic object then this method may return garbage. Use GetCameraToWorld() instead. */ const MT_Matrix4x4& GetModelviewMatrix() const; @@ -217,21 +217,21 @@ public: /** * Tests if the given sphere is inside this camera's view frustum. * - * @param center The center of the sphere, in world coordinates. - * @param radius The radius of the sphere. - * @return INSIDE, INTERSECT, or OUTSIDE depending on the sphere's relation to the frustum. + * \param center The center of the sphere, in world coordinates. + * \param radius The radius of the sphere. + * \return INSIDE, INTERSECT, or OUTSIDE depending on the sphere's relation to the frustum. */ int SphereInsideFrustum(const MT_Point3& center, const MT_Scalar &radius); /** * Tests the given eight corners of a box with the view frustum. * - * @param box a pointer to eight MT_Point3 representing the world coordinates of the corners of the box. - * @return INSIDE, INTERSECT, or OUTSIDE depending on the box's relation to the frustum. + * \param box a pointer to eight MT_Point3 representing the world coordinates of the corners of the box. + * \return INSIDE, INTERSECT, or OUTSIDE depending on the box's relation to the frustum. */ int BoxInsideFrustum(const MT_Point3 *box); /** * Tests the given point against the view frustum. - * @return true if the given point is inside or on the view frustum; false if it is outside. + * \return true if the given point is inside or on the view frustum; false if it is outside. */ bool PointInsideFrustum(const MT_Point3& x); diff --git a/source/gameengine/Ketsji/KX_GameObject.h b/source/gameengine/Ketsji/KX_GameObject.h index ea721d19179..843fba15725 100644 --- a/source/gameengine/Ketsji/KX_GameObject.h +++ b/source/gameengine/Ketsji/KX_GameObject.h @@ -284,7 +284,7 @@ public: ); /** - * @section Stuff which is here due to poor design. + * \section Stuff which is here due to poor design. * Inherited from CValue and needs an implementation. * Do not expect these functions do to anything sensible. */ @@ -324,7 +324,7 @@ public: ); /** - * @section Inherited from CValue. These are the useful + * \section Inherited from CValue. These are the useful * part of the CValue interface that this class implements. */ @@ -428,7 +428,7 @@ public: ); /** - * @return a pointer to the physics controller owned by this class. + * \return a pointer to the physics controller owned by this class. */ KX_IPhysicsController* GetPhysicsController(); @@ -449,7 +449,7 @@ public: } /** - * @return a pointer to the graphic controller owner by this class + * \return a pointer to the graphic controller owner by this class */ PHY_IGraphicController* GetGraphicController() { @@ -466,7 +466,7 @@ public: void ActivateGraphicController(bool recurse); /** - * @section Coordinate system manipulation functions + * \section Coordinate system manipulation functions */ void NodeSetLocalPosition(const MT_Point3& trans ); @@ -496,7 +496,7 @@ public: const MT_Point3& NodeGetLocalPosition( ) const; /** - * @section scene graph node accessor functions. + * \section scene graph node accessor functions. */ SG_Node* GetSGNode( ) @@ -510,7 +510,7 @@ public: } /** - * @section blender object accessor functions. + * \section blender object accessor functions. */ struct Object* GetBlenderObject( ) @@ -572,7 +572,7 @@ public: /** - * @section Physics accessors for this node. + * \section Physics accessors for this node. * * All these calls get passed directly to the physics controller * owned by this object. @@ -673,7 +673,7 @@ public: ); /** - * @section Mesh accessor functions. + * \section Mesh accessor functions. */ /** @@ -829,7 +829,7 @@ public: ) { return m_bIsNegativeScaling; } /** - * @section Logic bubbling methods. + * \section Logic bubbling methods. */ /** @@ -885,7 +885,7 @@ public: #ifdef WITH_PYTHON /** - * @section Python interface functions. + * \section Python interface functions. */ virtual PyObject* py_repr(void) { diff --git a/source/gameengine/Ketsji/KX_IPhysicsController.cpp b/source/gameengine/Ketsji/KX_IPhysicsController.cpp index 62e3c346dd8..bd75246a97f 100644 --- a/source/gameengine/Ketsji/KX_IPhysicsController.cpp +++ b/source/gameengine/Ketsji/KX_IPhysicsController.cpp @@ -1,6 +1,4 @@ /* - * @file KX_IPhysicsController.cpp - * * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -48,5 +46,3 @@ KX_IPhysicsController::KX_IPhysicsController(bool dyna, bool sensor, bool compou KX_IPhysicsController::~KX_IPhysicsController() { } - - diff --git a/source/gameengine/Ketsji/KX_KetsjiEngine.h b/source/gameengine/Ketsji/KX_KetsjiEngine.h index ab3126d90a0..7a29e2a2731 100644 --- a/source/gameengine/Ketsji/KX_KetsjiEngine.h +++ b/source/gameengine/Ketsji/KX_KetsjiEngine.h @@ -279,13 +279,13 @@ public: /** * Sets display of all frames. - * @param bUseFixedTime New setting for display all frames. + * \param bUseFixedTime New setting for display all frames. */ void SetUseFixedTime(bool bUseFixedTime); /** * Returns display of all frames. - * @return Current setting for display all frames. + * \return Current setting for display all frames. */ bool GetUseFixedTime(void) const; @@ -360,35 +360,35 @@ public: /** * Activates or deactivates timing information display. - * @param frameRate Display for frame rate on or off. - * @param profile Display for individual components on or off. - * @param properties Display of scene object debug properties on or off. + * \param frameRate Display for frame rate on or off. + * \param profile Display for individual components on or off. + * \param properties Display of scene object debug properties on or off. */ void SetTimingDisplay(bool frameRate, bool profile, bool properties); /** * Returns status of timing information display. - * @param frameRate Display for frame rate on or off. - * @param profile Display for individual components on or off. - * @param properties Display of scene object debug properties on or off. + * \param frameRate Display for frame rate on or off. + * \param profile Display for individual components on or off. + * \param properties Display of scene object debug properties on or off. */ void GetTimingDisplay(bool& frameRate, bool& profile, bool& properties) const; /** * Sets cursor hiding on every frame. - * @param hideCursor Turns hiding on or off. + * \param hideCursor Turns hiding on or off. */ void SetHideCursor(bool hideCursor); /** * Returns the current setting for cursor hiding. - * @return The current setting for cursor hiding. + * \return The current setting for cursor hiding. */ bool GetHideCursor(void) const; /** * Enables/disables the use of the framing bar color of the Blender file's scenes. - * @param overrideFrameColor The new setting. + * \param overrideFrameColor The new setting. */ void SetUseOverrideFrameColor(bool overrideFrameColor); @@ -399,17 +399,17 @@ public: /** * Set the color used for framing bar color instead of the one in the Blender file's scenes. - * @param r Red component of the override color. - * @param g Green component of the override color. - * @param b Blue component of the override color. + * \param r Red component of the override color. + * \param g Green component of the override color. + * \param b Blue component of the override color. */ void SetOverrideFrameColor(float r, float g, float b); /** * Returns the color used for framing bar color instead of the one in the Blender file's scenes. - * @param r Red component of the override color. - * @param g Green component of the override color. - * @param b Blue component of the override color. + * \param r Red component of the override color. + * \param g Green component of the override color. + * \param b Blue component of the override color. */ void GetOverrideFrameColor(float& r, float& g, float& b) const; @@ -424,7 +424,7 @@ protected: * Processes all scheduled scene activity. * At the end, if the scene lists have changed, * SceneListsChanged(void) is called. - * @see SceneListsChanged(void). + * \see SceneListsChanged(void). */ void ProcessScheduledScenes(void); diff --git a/source/gameengine/Ketsji/KX_MouseFocusSensor.h b/source/gameengine/Ketsji/KX_MouseFocusSensor.h index a4c15fe0968..c8e9dc6b6b7 100644 --- a/source/gameengine/Ketsji/KX_MouseFocusSensor.h +++ b/source/gameengine/Ketsji/KX_MouseFocusSensor.h @@ -76,7 +76,7 @@ class KX_MouseFocusSensor : public SCA_MouseSensor /** - * @attention Overrides default evaluate. + * \attention Overrides default evaluate. */ virtual bool Evaluate(); virtual void Init(); diff --git a/source/gameengine/Ketsji/KX_PolygonMaterial.h b/source/gameengine/Ketsji/KX_PolygonMaterial.h index f20a90f7deb..1af8a72c1fd 100644 --- a/source/gameengine/Ketsji/KX_PolygonMaterial.h +++ b/source/gameengine/Ketsji/KX_PolygonMaterial.h @@ -89,7 +89,7 @@ public: /** * Returns the caching information for this material, * This can be used to speed up the rasterizing process. - * @return The caching information. + * \return The caching information. */ virtual TCachingInfo GetCachingInfo(void) const { @@ -100,8 +100,8 @@ public: * Activates the material in the (OpenGL) rasterizer. * On entry, the cachingInfo contains info about the last activated material. * On exit, the cachingInfo should contain updated info about this material. - * @param rasty The rasterizer in which the material should be active. - * @param cachingInfo The information about the material used to speed up rasterizing. + * \param rasty The rasterizer in which the material should be active. + * \param cachingInfo The information about the material used to speed up rasterizing. */ void DefaultActivate(RAS_IRasterizer* rasty, TCachingInfo& cachingInfo) const; virtual bool Activate(RAS_IRasterizer* rasty, TCachingInfo& cachingInfo) const; @@ -115,7 +115,7 @@ public: /** * Returns the Blender texture face structure that is used for this material. - * @return The material's texture face. + * \return The material's texture face. */ MTFace* GetMTFace(void) const { diff --git a/source/gameengine/Ketsji/KX_PythonInit.cpp b/source/gameengine/Ketsji/KX_PythonInit.cpp index 401474b21a9..7c47fc59ac5 100644 --- a/source/gameengine/Ketsji/KX_PythonInit.cpp +++ b/source/gameengine/Ketsji/KX_PythonInit.cpp @@ -1720,7 +1720,7 @@ PyObject* initGameLogic(KX_KetsjiEngine *engine, KX_Scene* scene) // quick hack * These exist so the current blend dir "//" can always be used to import modules from. * the reason we need a few functions for this is that python is not only used by the game engine * so we cant just add to sys.path all the time, it would leave pythons state in a mess. - * It would also be incorrect since loading blend files for new levels etc would alwasy add to sys.path + * It would also be incorrect since loading blend files for new levels etc would always add to sys.path * * To play nice with blenders python, the sys.path is backed up and the current blendfile along * with all its lib paths are added to the sys path. diff --git a/source/gameengine/Ketsji/KX_Scene.cpp b/source/gameengine/Ketsji/KX_Scene.cpp index 20743504dad..56127c7b634 100644 --- a/source/gameengine/Ketsji/KX_Scene.cpp +++ b/source/gameengine/Ketsji/KX_Scene.cpp @@ -362,7 +362,7 @@ void KX_Scene::SetFramingType(RAS_FrameSettings & frame_settings) /** * Return a const reference to the framing * type set by the above call. - * The contents are not guarenteed to be sensible + * The contents are not guaranteed to be sensible * if you don't call the above function. */ const RAS_FrameSettings& KX_Scene::GetFramingType() const diff --git a/source/gameengine/Ketsji/KX_Scene.h b/source/gameengine/Ketsji/KX_Scene.h index 2aae58d564f..1fa981e18f9 100644 --- a/source/gameengine/Ketsji/KX_Scene.h +++ b/source/gameengine/Ketsji/KX_Scene.h @@ -53,7 +53,7 @@ #include "RAS_2DFilterManager.h" /** - * @section Forward declarations + * \section Forward declarations */ struct SM_MaterialProps; struct SM_ShapeProps; @@ -181,7 +181,7 @@ protected: KX_WorldInfo* m_worldinfo; /** - * @section Different scenes, linked to ketsji scene + * \section Different scenes, linked to ketsji scene */ /** @@ -342,7 +342,7 @@ public: void RemoveAnimatedObject(CValue* gameobj); /** - * @section Logic stuff + * \section Logic stuff * Initiate an update of the logic system. */ void LogicBeginFrame(double curtime); @@ -451,7 +451,7 @@ public: /** * Activates new desired canvas width set at design time. - * @param width The new desired width. + * \param width The new desired width. */ void SetCanvasDesignWidth( @@ -459,7 +459,7 @@ public: ); /** * Activates new desired canvas height set at design time. - * @param width The new desired height. + * \param width The new desired height. */ void SetCanvasDesignHeight( @@ -467,7 +467,7 @@ public: ); /** * Returns the current desired canvas width set at design time. - * @return The desired width. + * \return The desired width. */ unsigned int GetCanvasDesignWidth( @@ -476,7 +476,7 @@ public: /** * Returns the current desired canvas height set at design time. - * @return The desired height. + * \return The desired height. */ unsigned int GetCanvasDesignHeight( @@ -495,7 +495,7 @@ public: /** * Return a const reference to the framing * type set by the above call. - * The contents are not guarenteed to be sensible + * The contents are not guaranteed to be sensible * if you don't call the above function. */ @@ -518,7 +518,7 @@ public: const RAS_Rect& GetSceneViewport() const; /** - * @section Accessors to different scenes of this scene + * \section Accessors to different scenes of this scene */ void SetNetworkDeviceInterface(NG_NetworkDeviceInterface* newInterface); void SetNetworkScene(NG_NetworkScene *newScene); diff --git a/source/gameengine/Ketsji/KX_TimeCategoryLogger.h b/source/gameengine/Ketsji/KX_TimeCategoryLogger.h index f01e405d3df..62b74871603 100644 --- a/source/gameengine/Ketsji/KX_TimeCategoryLogger.h +++ b/source/gameengine/Ketsji/KX_TimeCategoryLogger.h @@ -52,7 +52,7 @@ public: /** * Constructor. - * @param maxNumMesasurements Maximum number of measurements stored (> 1). + * \param maxNumMesasurements Maximum number of measurements stored (> 1). */ KX_TimeCategoryLogger(unsigned int maxNumMeasurements = 10); @@ -73,40 +73,40 @@ public: /** * Adds a category. - * @param category The new category. + * \param category The new category. */ virtual void AddCategory(TimeCategory tc); /** * Starts logging in current measurement for the given category. - * @param tc The category to log to. - * @param now The current time. - * @param endOtherCategories Whether to stop logging to other categories. + * \param tc The category to log to. + * \param now The current time. + * \param endOtherCategories Whether to stop logging to other categories. */ virtual void StartLog(TimeCategory tc, double now, bool endOtherCategories = true); /** * End logging in current measurement for the given category. - * @param tc The category to log to. - * @param now The current time. + * \param tc The category to log to. + * \param now The current time. */ virtual void EndLog(TimeCategory tc, double now); /** * End logging in current measurement for all categories. - * @param now The current time. + * \param now The current time. */ virtual void EndLog(double now); /** * Logs time in next measurement. - * @param now The current time. + * \param now The current time. */ virtual void NextMeasurement(double now); /** * Returns average of all but the current measurement time. - * @return The average of all but the current measurement. + * \return The average of all but the current measurement. */ virtual double GetAverage(TimeCategory tc); diff --git a/source/gameengine/Ketsji/KX_TimeLogger.h b/source/gameengine/Ketsji/KX_TimeLogger.h index 16d97c1fe41..b2336c2c512 100644 --- a/source/gameengine/Ketsji/KX_TimeLogger.h +++ b/source/gameengine/Ketsji/KX_TimeLogger.h @@ -49,7 +49,7 @@ class KX_TimeLogger { public: /** * Constructor. - * @param maxNumMesasurements Maximum number of measurements stored (>1). + * \param maxNumMesasurements Maximum number of measurements stored (>1). */ KX_TimeLogger(unsigned int maxNumMeasurements = 10); @@ -70,25 +70,25 @@ public: /** * Starts logging in current measurement. - * @param now The current time. + * \param now The current time. */ virtual void StartLog(double now); /** * End logging in current measurement. - * @param now The current time. + * \param now The current time. */ virtual void EndLog(double now); /** * Logs time in next measurement. - * @param now The current time. + * \param now The current time. */ virtual void NextMeasurement(double now); /** * Returns average of all but the current measurement. - * @return The average of all but the current measurement. + * \return The average of all but the current measurement. */ virtual double GetAverage(void) const; diff --git a/source/gameengine/Network/NG_NetworkScene.h b/source/gameengine/Network/NG_NetworkScene.h index cd6f9925582..b3ca4df9d50 100644 --- a/source/gameengine/Network/NG_NetworkScene.h +++ b/source/gameengine/Network/NG_NetworkScene.h @@ -105,7 +105,7 @@ protected: /** * Releases messages for the given message map. - * @param map Message map with messages. + * \param map Message map with messages. */ void ClearMessageMap(TMessageMap& map); diff --git a/source/gameengine/PyDoc/API_intro.py b/source/gameengine/PyDoc/API_intro.py deleted file mode 100644 index 097abbfbf1a..00000000000 --- a/source/gameengine/PyDoc/API_intro.py +++ /dev/null @@ -1,110 +0,0 @@ -# This is not a real module, it's simply an introductory text. - -""" -The Blender Game Engine Python API Reference -============================================ - - See U{release notes<http://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.49/Game_Engine>} for updates, changes and new functionality in the Game Engine Python API. - - Blender Game Engine Modules: - ---------------------------- - - Modules that include methods for accessing GameEngine data and functions. - - - L{GameLogic} utility functons for game logic. - - L{GameKeys} keyboard input and event conversion. - - L{Rasterizer} display and rendering. - - L{GameTypes} contains all the python types spesific to the GameEngine. - - Modules with documentation in progress: - --------------------- - - L{VideoTexture} - - L{PhysicsConstraints} - - Additional Modules: - ------------------- - - These modules have no GameEngine specific functionality but are useful in many cases. - - - L{mathutils} - - L{Geometry} - - L{BGL} - - -Introduction: -============= - - This reference documents the Blender Python API, a growing collection of - Python modules (libraries) that give access to part of the program's internal - data and functions. - - Through scripting Blender can be extended in real-time via - U{Python <www.python.org>}, an impressive high level, multi-paradigm, open - source language. Newcomers are recommended to start with the tutorial that - comes with it. - - This opens many interesting possibilities not available with logic bricks. - - Game Engine API Stability: - -------------------------- - - When writing python scripts there are a number of situations you should avoid to prevent crashes or unstable behavior. - While the API tries to prevent problems there are some situations where error checking would be too time consuming. - - Known cases: - - Memory Limits. - - There is nothing stopping you from filling a list or making a string so big that that causes blender to run out of memory, in this case python should rasie a MemoryError, but its likely blender will crash before this point. - - - Accessing any data that has been freed. - - For instance accessing a KX_GameObject after its End Object actuator runs. - This will cause a SystemError, however for L{KX_MeshProxy}, L{KX_VertexProxy} and L{KX_VertexProxy} it will crash the blender game engine. - - See: L{GameTypes.PyObjectPlus.invalid} which many types inherit. - - - Mixing L{KX_GameObject} between scenes. - - For instance tracking/parenting an L{KX_GameObject} object to an object from other scene. - - External Modules: - ----------------- - - Since 2.49 support for importing modules has been added. - - This allows you to import any blender textblock with a .py extension. - - External python scripts may be imported as modules when the script is in the same directory as the blend file. - - The current blend files path is included in the sys.path for loading modules. - All linked libraries will also be included so you can be sure when linking in assets from another blend file the scripts will load too. - - A note to newbie script writers: - -------------------------------- - - Interpreted languages are known to be much slower than compiled code, but for - many applications the difference is negligible or acceptable. Also, with - profiling (or even simple direct timing with L{Blender.sys.time<Sys.time>}) to - identify slow areas and well thought optimizations, the speed can be - I{considerably} improved in many cases. Try some of the best BPython scripts - to get an idea of what can be done, you may be surprised. - -@author: The Blender Python Team -@requires: Blender 2.49 or newer. -@version: 2.49 -@see: U{www.blender.org<http://www.blender.org>}: documentation and forum -@see: U{blenderartists.org<http://blenderartists.org>}: user forum -@see: U{projects.blender.org<http://projects.blender.org>} -@see: U{www.python.org<http://www.python.org>} -@see: U{www.python.org/doc<http://www.python.org/doc>} -@see: U{Blending into Python<en.wikibooks.org/wiki/Blender_3D:_Blending_Into_Python>}: User contributed documentation, featuring a blender/python cookbook with many examples. - -@note: the official version of this reference guide is only updated for each - new Blender release. But you can build the current SVN - version yourself: install epydoc, grab all files in the - source/gameengine/PyDoc/ folder of Blender's SVN and use the - epy_docgen.sh script also found there to generate the html docs. - Naturally you will also need a recent Blender binary to try the new - features. If you prefer not to compile it yourself, there is a testing - builds forum at U{blender.org<http://www.blender.org>}. -""" diff --git a/source/gameengine/PyDoc/PhysicsConstraints.py b/source/gameengine/PyDoc/PhysicsConstraints.py deleted file mode 100644 index bec8973edc6..00000000000 --- a/source/gameengine/PyDoc/PhysicsConstraints.py +++ /dev/null @@ -1,293 +0,0 @@ -""" -Documentation for the PhysicsConstraints module. -================================================ - -Example:: - - - # Adding a point constraint # - ############################### - - - # import BGE internal module - import PhysicsConstraints - - # get object list - obj_list = GameLogic.getCurrentScene().objects - - # get object named Obj_1 - root = obj_list["root"] - obj = obj_list["obj"] - - # get object physics ID - phido = obj.getPhysicsId() - - # get root physics ID - phidr = root.getPhysicsId() - - # want to use point constraint type - constraint_type = 1 - - # Use bottom right front corner of object for point constraint position - point_pos_x = 1.0 - point_pos_y = -1.0 - point_pos_z = -1.0 - - # create a point constraint - const = PhysicsConstraints.createConstraint( phido, phidr, constraint_type, point_pos_x, point_pos_y, point_pos_z) - - # stores the new constraint ID to be used later - obj["constraint_ID"] = const.getConstraintId() - - -Example:: - - - # Removing a point constraint # - ################################# - - - # import BGE internal module - import PhysicsConstraints - - # get object list - obj_list = GameLogic.getCurrentScene().objects - - # get object 1 - obj = obj_list["obj"] - - # get constraint ID that was saved as an obj property - # when the constraint was created - constraint_ID = obj["constraint_ID"] - - # remove constraint - PhysicsConstraints.removeConstraint(constraint_ID) - -""" - -def createConstraint(obj_PhysicsID, root_PhysicsID, constraintType, pointPos_x, pointPos_y, pointPos_z, edgePos_x, edgePos_y, edgePos_z, edgeAngle_x, edgeAngle_y, edgeAngle_z): - """ - Create a point constraint between two objects, an edge constraint between two objects, or a vehicle constraint on an object. - - You only have to input the needed parammeters depending on the type of constraint you are trying to create. - - - B{Point Constraint} :: - - While creating a point constraint, the "pointPos" values define where you want the pivot point to be located. - If you are creating a point constraint be sure to assing the integer "1" as the constraintType value. - - Parameters to use: - obj_PhysicsID, root_PhysicsID, constraintType, pointPos_x, pointPos_y, pointPos_z - - B{Edge Constraint} :: - - While creating an edge constraint, the "edgePos" values define where you want the center of the edge constraint to be. - Also, the "edgeAngle" values define in which direction you want the edge constraint to point (As a 3 dimensions vector). - If you want to create an edge constraint be sure to assing the integer "2" as the constraintType value. - - Parameters to use: - obj_PhysicsID, root_PhysicsID, constraintType, edgePos_x, edgePos_y, edgePos_z, edgeAngle_x, edgeAngle_y, edgeAngle_z} - - B{Vehicle Constraint} :: - - While creating a point constraint, the "pointPos" values define where you want the pivot point to be located. - If you want to create an edge constraint be sure to assing the integer "0" as the constraintType value. - - Parameters to use : - obj_PhysicsID, root_PhysicsID, constraintType - - @type obj_PhysicsID: integer - @param obj_PhysicsID: The physic ID of the first object to constraint. - - @type root_PhysicsID: integer - @param root_PhysicsID: The physic ID of the second object to constraint. - - @type constraintType: integer - @param constraintType: The type of constraint. - - @type pointPos_x: float - @param pointPos_x: The X position of the point constraint. - - @type pointPos_y: float - @param pointPos_y: The Y position of the point constraint. - - @type pointPos_z: float - @param pointPos_z: The Z position of the point constraint. - - @type edgePos_x: float - @param edgePos_x: The X value of the center of the edge constraint. - - @type edgePos_y: float - @param edgePos_y: The Y value of the center of the edge constraint. - - @type edgePos_z: float - @param edgePos_z: The Z value of the center of the edge constraint. - - @type edgeAngle_x: float - @param edgeAngle_x: The X value of the edge's orientation vector. - - @type edgeAngle_y: float - @param edgeAngle_y: The Y value of the edge's orientation vector. - - @type edgeAngle_z: float - @param edgeAngle_z: The Z value of the edge's orientation vector. - - @rtype: integer - @return: The created constraint ID - """ - - -def getAppliedImpulse(constraint_ID): - """ - Returns the applied impulse. - - @param constraint_ID: The constraint ID that was saved on the creation of the constraint. - @type constraint_ID: integer - @rtype: float - @return: Measure the stress on a constraint. - """ - - -def getVehicleConstraint(constraint_ID): - """ - Returns the vehicle constraint ID. - - @param constraint_ID: The constraint ID that was saved on the creation of the constraint. - @type constraint_ID: integer - @rtype: integer - """ -def removeConstraint(constraint_ID): - """ - - Removes the constraint between 2 game objects (point and edge constraints). - - It does not remove vehicle constraints. - - @param constraint_ID: The constraint ID that was saved on the creation of the constraint. - @type constraint_ID: integer - """ -def setDeactivationLinearTreshold(linearTreshold): - """ - - Sets the linear velocity that an object must be below before the deactivation timer can start. - - This affects every object in the scene, except for game objects that have 'No sleeping' turned on. - - @param linearTreshold: The linear velocity. - @type linearTreshold: float - """ -def setDeactivationAngularTreshold(angularTreshold): - """ - - Sets the angular velocity that an object must be below before the deactivation timer can start. - - This affects every object in the scene, except for game objects that have 'No sleeping' turned on. - - @param angularTreshold: The angular velocity. - @type angularTreshold: float - """ -def setDeactivationTime(time): - """ - - Time (in seconds) after objects with velocity less then thresholds (see below) are deactivated. - - This affects every object in the scene, except for game objects that have 'No sleeping' turned on. - - This function is directly related with the 2 above functions. - - - @param time: The time in seconds. - @type time: float - """ -def setGravity(gx, gy, gz): - """ - Sets the gravity for the actual scene only. - - All other scenes remain unaffected. - - This affects every object in the scene that has physics enabled. - - @param gx: The force of gravity on world x axis. - @type gx: float - @param gy: The force of gravity on world y axis. - @type gy: float - @param gz: The force of gravity on world z axis. - @type gz: float - """ -def setLinearAirDamping(damping): - """ - - Sets the linear air resistance for all objects in the scene. - - @param damping: The linear air resistance. - @type damping: float - """ -def setNumIterations(numIter): - """ - Sets the number of times an iterative constraint solver is repeated. - - Increasing the number of iterations improves the constraint solver at the cost of performances & the speed of the game engine. - - @param numIter: The number of timesubsteps. (Input 0 to suspend simulation numSubStep) - @type numIter: integer - """ -def setNumTimeSubSteps(numSubStep): - """ - Set the quality of the entire physics simulation including collision detection and constraint solver. - - Increase the number of time substeps to improves the quality of the entire physics simulation at the cost of the performance & the speed of the game engine. - - @param numSubStep: The number of timesubsteps. (Input 0 to suspend simulation numSubStep) - @type numSubStep: integer - """ -#def setDebugMode(): -# """ -# -# -# -# @param numIter: -# @type numIter: -# """ -#def setCcdMode(): -# """ -# Does something -# -# @rtype: -# """ -#def setContactBreakingTreshold(): -# """ -# Does something -# -# @rtype: -# """ -#def setSolverDamping(): -# """ -# Does something -# -# @rtype: -# """ -#def setSolverTau(): -# """ -# Does something -# -# @rtype: -# """ -#def setSolverType(): -# """ -# Does something -# -# @rtype: -# """ -#def setSorConstant(): -# """ -# Does something -# -# @rtype: -# """ -#def setUseEpa(): -# """ -# Does something -# -# @rtype: -# """ diff --git a/source/gameengine/PyDoc/VideoTexture.py b/source/gameengine/PyDoc/VideoTexture.py deleted file mode 100644 index 9d2148d8eaf..00000000000 --- a/source/gameengine/PyDoc/VideoTexture.py +++ /dev/null @@ -1,217 +0,0 @@ -""" -The VideoTexture module allows you to manipulate textures during the game. - -Several sources for texture are possible: video files, image files, -video capture, memory buffer, camera render or a mix of that. - -The video and image files can be loaded from the internet using an URL -instead of a file name. - -In addition, you can apply filters on the images before sending them to the GPU, allowing video effect: blue screen, -color band, gray, normal map. - -VideoTexture uses FFmpeg to load images and videos. All the formats and codecs -that FFmpeg supports are supported by VideoTexture, including but not limited to:: - - * AVI - * Ogg - * Xvid - * Theora - * dv1394 camera - * video4linux capture card (this includes many webcams) - * videoForWindows capture card (this includes many webcams) - * JPG - -The principle is simple: first you identify a texture on an existing object using -the L{materialID} function, then you create a new texture with dynamic content -and swap the two textures in the GPU. - -The GE is not aware of the substitution and continues to display the object as always, -except that you are now in control of the texture. - -When the texture object is deleted, the new texture is deleted and the old texture restored. - -Example:: - import VideoTexture - import GameLogic - - contr = GameLogic.getCurrentController() - obj = contr.owner - - # the creation of the texture must be done once: save the - # texture object in an attribute of GameLogic module makes it persistent - if not hasattr(GameLogic, 'video'): - - # identify a static texture by name - matID = VideoTexture.materialID(obj, 'IMvideo.png') - - # create a dynamic texture that will replace the static texture - GameLogic.video = VideoTexture.Texture(obj, matID) - - # define a source of image for the texture, here a movie - movie = GameLogic.expandPath('//trailer_400p.ogg') - GameLogic.video.source = VideoTexture.VideoFFmpeg(movie) - GameLogic.video.source.scale = True - - # quick off the movie, but it wont play in the background - GameLogic.video.source.play() - - # you need to call this function every frame to ensure update of the texture. - GameLogic.video.refresh(True) - - -""" -def getLastError(): - """ - Returns the description of the last error that occurred in a VideoTexture function. - - @rtype: string - """ -def imageToArray(image,mode): - """ - Returns a BGL.buffer corresponding to the current image stored in a texture source object - - @param image: Image source object. - @type image: object of type L{VideoFFmpeg}, L{ImageFFmpeg}, L{ImageBuff}, L{ImageMix}, L{ImageRender}, L{ImageMirror} or L{ImageViewport} - @param mode: optional argument representing the pixel format. - You can use the characters R, G, B for the 3 color channels, A for the alpha channel, - 0 to force a fixed 0 color channel and 1 to force a fixed 255 color channel. - Example: "BGR" will return 3 bytes per pixel with the Blue, Green and Red channels in that order. \ - "RGB1" will return 4 bytes per pixel with the Red, Green, Blue channels in that order and the alpha channel forced to 255. - The default mode is "RGBA". - @type mode: string - @rtype: BGL.buffer - @returns: object representing the image as one dimensional array of bytes of size (pixel_size*width*height), line by line starting from the bottom of the image. The pixel size and format is determined by the mode parameter. - """ - -def materialID(object,name): - """ - Returns a numeric value that can be used in L{Texture} to create a dynamic texture. - - The value corresponds to an internal material number that uses the texture identified - by name. name is a string representing a texture name with IM prefix if you want to - identify the texture directly. This method works for basic tex face and for material, - provided the material has a texture channel using that particular texture in first - position of the texture stack. name can also have MA prefix if you want to identify - the texture by material. In that case the material must have a texture channel in first - position. - - If the object has no material that matches name, it generates a runtime error. Use try/except to catch the exception. - - Ex: VideoTexture.materialID(obj, 'IMvideo.png') - - @param object: the game object that uses the texture you want to make dynamic - @type object: game object - @param name: name of the texture/material you want to make dynamic. - @type name: string - @rtype: integer - """ -def setLogFile(filename): - """ - Sets the name of a text file in which runtime error messages will be written, in addition to the printing - of the messages on the Python console. Only the runtime errors specific to the VideoTexture module - are written in that file, ordinary runtime time errors are not written. - - @param filename: name of error log file - @type filename: string - @rtype: integer - """ -def FilterBGR24(): - """ - Returns a new input filter object to be used with L{ImageBuff} object when the image passed - to the ImageBuff.load() function has the 3-bytes pixel format BGR. - - @rtype: object of type FilterBGR24 - """ -def FilterBlueScreen(): - """ - Does something - - @rtype: - """ -def FilterColor(): - """ - Does something - - @rtype: - """ -def FilterGray(): - """ - Does something - - @rtype: - """ -def FilterLevel(): - """ - Does something - - @rtype: - """ -def FilterNormal(): - """ - Does something - - @rtype: - """ -def FilterRGB24(): - """ - Returns a new input filter object to be used with L{ImageBuff} object when the image passed - to the ImageBuff.load() function has the 3-bytes pixel format RBG. - - @rtype: object of type FilterRGB24 - """ -def FilterRGBA32(): - """ - Returns a new input filter object to be used with L{ImageBuff} object when the image passed - to the ImageBuff.load() function has the 4-bytes pixel format RGBA. - - @rtype: object of type FilterRGBA32 - """ -def ImageBuff(): - """ - Does something - - @rtype: - """ -def ImageFFmpeg(): - """ - Does something - - @rtype: - """ -def ImageMirror(): - """ - Does something - - @rtype: - """ -def ImageMix(): - """ - Does something - - @rtype: - """ -def ImageRender(): - """ - Does something - - @rtype: - """ -def ImageViewport(): - """ - Does something - - @rtype: - """ -def Texture(): - """ - Does something - - @rtype: L{Texture} - """ -def VideoFFmpeg(): - """ - Does something - - @rtype: - """ diff --git a/source/gameengine/PyDoc/bge_api_validate_py.txt b/source/gameengine/PyDoc/bge_api_validate_py.txt deleted file mode 100644 index ebd74c06bb3..00000000000 --- a/source/gameengine/PyDoc/bge_api_validate_py.txt +++ /dev/null @@ -1,136 +0,0 @@ -#~ This program is free software; you can redistribute it and/or modify -#~ it under the terms of the GNU General Public License as published by -#~ the Free Software Foundation; version 2 of the License. - -#~ This program is distributed in the hope that it will be useful, -#~ but WITHOUT ANY WARRANTY; without even the implied warranty of -#~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -#~ GNU General Public License for more details. - -# This script must run from a logic brick so it has access to the game engine api -# it assumes the root blender source directory is the current working directory -# -# Currently it only prints missing modules and methods (not attributes) - -import sys, os - -BGE_API_DOC_PATH = 'source/gameengine/PyDoc' - - -mods = ['GameLogic', 'Rasterizer', 'GameKeys'] -mods_dict = {} -for m in mods: - mods_dict[m] = sys.modules[m] - - -import GameTypes -type_members = {} - -for type_name in dir(GameTypes): - if type_name.startswith('__'): - continue - - type_object = getattr(GameTypes, type_name) - - members = [] - type_members[type_object.__name__] = members - - for member in type_object.__dict__.keys(): - if member.startswith('__'): - continue - - # print type_object.__name__ + '.' + k - members.append(member) - - - -doc_dir= os.path.join(os.getcwd(), BGE_API_DOC_PATH) - -if doc_dir not in sys.path: - sys.path.append(doc_dir) - - -def check_attribute(class_ob, member): - doc = class_ob.__doc__ - if not doc: - return False - - for l in doc.split('\n'): - l = l.strip() - - ''' - @ivar foo: blah blah - to - foo - - ''' - - if l.startswith('@ivar') or l.startswith('@var'): - var = l.split()[1].split(':')[0] - - if var == member: - return True - - return False - - - - - - -print '\n\n\nChecking Docs' - -PRINT_OK = False - -pymod = sys.modules['GameTypes'] -del sys.modules['GameTypes'] # temp remove -mod = __import__('GameTypes') # get the python module -reload(mod) # incase were editing it -sys.modules['GameTypes'] = pymod - -for type_name in sorted(type_members.keys()): - members = type_members[type_name] - - try: - type_class = getattr(mod, type_name) - except: - print "missing class: %s.%s - %s" % (type_name, type_name, str(sorted(members))) - continue - - for member in sorted(members): - try: - getattr(type_class, member) - if PRINT_OK: - print "\tfound: %s.%s" % (type_name, member) - except: - if check_attribute(type_class, member): - if PRINT_OK: - print "\tfound attr: %s.%s" % (type_name, member) - else: - print "\tmissing: %s.%s" % (type_name, member) - - -# Now check the modules -for mod_name, pymod in mods_dict.iteritems(): - print pymod - del sys.modules[mod_name] - - # Now well get the python version - pydoc = __import__(mod_name) - pydoc = reload(pydoc) # avoid using the out dated pyc file only - print pydoc.__file__ - - for member in sorted(dir(pymod)): - if hasattr(pydoc, member) or check_attribute(pydoc, member): - if PRINT_OK: - print "\tfound module attr: %s.%s" % (mod_name, member) - else: - print "\tmissing module attr: %s.%s" % (mod_name, member) - - # Restore real module - sys.modules[mod_name] = pymod - - -sys.path.pop() # remove the pydoc dir from our import paths - - diff --git a/source/gameengine/PyDoc/epy_docgen.sh b/source/gameengine/PyDoc/epy_docgen.sh deleted file mode 100755 index dd30256f42f..00000000000 --- a/source/gameengine/PyDoc/epy_docgen.sh +++ /dev/null @@ -1,16 +0,0 @@ -# epy_docgen.sh -# generates blender python doc using epydoc -# requires epydoc in your PATH. -# run from the doc directory containing the .py files -# usage: sh epy_docgen.sh - -# set posix locale so regex works properly for [A-Z]*.py -LC_ALL=POSIX - -epydoc --debug -v -o BPY_GE --url "http://www.blender.org" --top API_intro \ - --name "Blender GameEngine" --no-private --no-sourcecode --inheritance=included \ - *.py \ - ../../../source/blender/python/api2_2x/doc/BGL.py \ - ../../../source/blender/python/api2_2x/doc/Mathutils.py \ - ../../../source/blender/python/api2_2x/doc/Geometry.py - diff --git a/source/gameengine/PyDoc/how_to_build_win.txt b/source/gameengine/PyDoc/how_to_build_win.txt deleted file mode 100644 index 5610ced3b2a..00000000000 --- a/source/gameengine/PyDoc/how_to_build_win.txt +++ /dev/null @@ -1,16 +0,0 @@ -How To Build the BGE Documentation in Windows -------------------------------------------------------------------------- -1) download and install Python 2.6 - http://www.python.org -2) download and install Epydocs - http://epydoc.sourceforge.net - -* for the following lines we will assume that your installation of Python is in C:\Python26 and epydocs is installed in the default folder Scripts\epydoc. - -3) creates a epy_docgen.bat file in this folder (source\gameengine\PyDoc\) and paste the following line into it: - -:::::: -C:\Python26\python.exe C:\Python26\Scripts\epydoc.py --debug -v -o BPY_GE --url "http://www.blender.org" --top API_intro --name "Blender GameEngine" --no-private --no-sourcecode --inheritance=included *.py ../../../source/blender/python/api2_2x/doc/BGL.py ../../../source/blender/python/api2_2x/doc/Mathutils.py ../../../source/blender/python/api2_2x/doc/Geometry.py -:::::: - -4) run your created batch file. If everything goes well it creates a folder named BPY_GE with all the generated documentation. - -Documentation valid in March of 2010 - Blender 2.5alpha2 diff --git a/source/gameengine/Rasterizer/RAS_FramingManager.h b/source/gameengine/Rasterizer/RAS_FramingManager.h index 4ea2d998190..ddf889aeb37 100644 --- a/source/gameengine/Rasterizer/RAS_FramingManager.h +++ b/source/gameengine/Rasterizer/RAS_FramingManager.h @@ -39,7 +39,7 @@ class RAS_Rect; /** - * @section RAS_FrameSettings + * \section RAS_FrameSettings * This is a value type describing the framing used * by a particular scene in the game engine. * Each KX_Scene contains a RAS_FrameSetting describing @@ -193,7 +193,7 @@ enum RAS_SensorFit }; /** - * @section RAS_FramingManager + * \section RAS_FramingManager * This class helps to compute a view frustum * and a viewport rectangle given the * above settings and a description of the diff --git a/source/gameengine/Rasterizer/RAS_ICanvas.h b/source/gameengine/Rasterizer/RAS_ICanvas.h index e35ec1d16d2..b7c26928378 100644 --- a/source/gameengine/Rasterizer/RAS_ICanvas.h +++ b/source/gameengine/Rasterizer/RAS_ICanvas.h @@ -80,8 +80,8 @@ public: * Initializes the canvas for drawing. Drawing to the canvas is * only allowed between BeginDraw() and EndDraw(). * - * @retval false Acquiring the canvas failed. - * @retval true Acquiring the canvas succeeded. + * \retval false Acquiring the canvas failed. + * \retval true Acquiring the canvas succeeded. * */ diff --git a/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h b/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h index 0da0b17f6c1..3257682649f 100644 --- a/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h +++ b/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h @@ -135,7 +135,7 @@ public: /** * Returns the caching information for this material, * This can be used to speed up the rasterizing process. - * @return The caching information. + * \return The caching information. */ virtual TCachingInfo GetCachingInfo(void) const { return 0; } @@ -143,8 +143,8 @@ public: * Activates the material in the rasterizer. * On entry, the cachingInfo contains info about the last activated material. * On exit, the cachingInfo should contain updated info about this material. - * @param rasty The rasterizer in which the material should be active. - * @param cachingInfo The information about the material used to speed up rasterizing. + * \param rasty The rasterizer in which the material should be active. + * \param cachingInfo The information about the material used to speed up rasterizing. */ virtual bool Activate(RAS_IRasterizer* rasty, TCachingInfo& cachingInfo) const { @@ -177,7 +177,7 @@ public: virtual void Replace_IScene(SCA_IScene *val) {}; /* overridden by KX_BlenderMaterial */ /** - * @return the equivalent drawing mode for the material settings (equivalent to old TexFace tface->mode). + * \return the equivalent drawing mode for the material settings (equivalent to old TexFace tface->mode). */ int ConvertFaceMode(struct GameSettings *game, bool image) const; diff --git a/source/gameengine/Rasterizer/RAS_IRasterizer.h b/source/gameengine/Rasterizer/RAS_IRasterizer.h index c749868cf79..34ddafbf2cc 100644 --- a/source/gameengine/Rasterizer/RAS_IRasterizer.h +++ b/source/gameengine/Rasterizer/RAS_IRasterizer.h @@ -202,7 +202,7 @@ public: virtual void SetStereoMode(const StereoMode stereomode)=0; /** * Stereo can be used to query if the rasterizer is in stereo mode. - * @return true if stereo mode is enabled. + * \return true if stereo mode is enabled. */ virtual bool Stereo()=0; virtual StereoMode GetStereoMode()=0; @@ -236,7 +236,7 @@ public: /** * IndexPrimitives_3DText will render text into the polygons. - * The text to be rendered is from @param rendertools client object's text property. + * The text to be rendered is from \param rendertools client object's text property. */ virtual void IndexPrimitives_3DText(class RAS_MeshSlot& ms, class RAS_IPolyMaterial* polymat, @@ -247,7 +247,7 @@ public: /** * Set the projection matrix for the rasterizer. This projects * from camera coordinates to window coordinates. - * @param mat The projection matrix. + * \param mat The projection matrix. */ virtual void SetProjectionMatrix(const MT_Matrix4x4 & mat)=0; /** @@ -292,11 +292,11 @@ public: float alpha)=0; /** - * @param drawingmode = KX_BOUNDINGBOX, KX_WIREFRAME, KX_SOLID, KX_SHADED or KX_TEXTURED. + * \param drawingmode = KX_BOUNDINGBOX, KX_WIREFRAME, KX_SOLID, KX_SHADED or KX_TEXTURED. */ virtual void SetDrawingMode(int drawingmode)=0; /** - * @return the current drawing mode: KX_BOUNDINGBOX, KX_WIREFRAME, KX_SOLID, KX_SHADED or KX_TEXTURED. + * \return the current drawing mode: KX_BOUNDINGBOX, KX_WIREFRAME, KX_SOLID, KX_SHADED or KX_TEXTURED. */ virtual int GetDrawingMode()=0; /** @@ -312,13 +312,13 @@ public: virtual double GetTime()=0; /** * Generates a projection matrix from the specified frustum. - * @param left the left clipping plane - * @param right the right clipping plane - * @param bottom the bottom clipping plane - * @param top the top clipping plane - * @param frustnear the near clipping plane - * @param frustfar the far clipping plane - * @return a 4x4 matrix representing the projection transform. + * \param left the left clipping plane + * \param right the right clipping plane + * \param bottom the bottom clipping plane + * \param top the top clipping plane + * \param frustnear the near clipping plane + * \param frustfar the far clipping plane + * \return a 4x4 matrix representing the projection transform. */ virtual MT_Matrix4x4 GetFrustumMatrix( float left, @@ -333,13 +333,13 @@ public: /** * Generates a orthographic projection matrix from the specified frustum. - * @param left the left clipping plane - * @param right the right clipping plane - * @param bottom the bottom clipping plane - * @param top the top clipping plane - * @param frustnear the near clipping plane - * @param frustfar the far clipping plane - * @return a 4x4 matrix representing the projection transform. + * \param left the left clipping plane + * \param right the right clipping plane + * \param bottom the bottom clipping plane + * \param top the top clipping plane + * \param frustnear the near clipping plane + * \param frustfar the far clipping plane + * \return a 4x4 matrix representing the projection transform. */ virtual MT_Matrix4x4 GetOrthoMatrix( float left, diff --git a/source/gameengine/Rasterizer/RAS_IRenderTools.h b/source/gameengine/Rasterizer/RAS_IRenderTools.h index 27b328412d2..1d9f7052975 100644 --- a/source/gameengine/Rasterizer/RAS_IRenderTools.h +++ b/source/gameengine/Rasterizer/RAS_IRenderTools.h @@ -103,13 +103,13 @@ public: /** * Renders 3D text string using BFL. - * @param fontid The id of the font. - * @param text The string to render. - * @param size The size of the text. - * @param dpi The resolution of the text. - * @param color The color of the object. - * @param mat The Matrix of the text object. - * @param aspect A scaling factor to compensate for the size. + * \param fontid The id of the font. + * \param text The string to render. + * \param size The size of the text. + * \param dpi The resolution of the text. + * \param color The color of the object. + * \param mat The Matrix of the text object. + * \param aspect A scaling factor to compensate for the size. */ virtual void @@ -125,12 +125,12 @@ public: /** * Renders 2D text string. - * @param mode The type of text - * @param text The string to render. - * @param xco Position on the screen (origin in lower left corner). - * @param yco Position on the screen (origin in lower left corner). - * @param width Width of the canvas to draw to. - * @param height Height of the canvas to draw to. + * \param mode The type of text + * \param text The string to render. + * \param xco Position on the screen (origin in lower left corner). + * \param yco Position on the screen (origin in lower left corner). + * \param width Width of the canvas to draw to. + * \param height Height of the canvas to draw to. */ virtual void diff --git a/source/gameengine/SceneGraph/SG_BBox.h b/source/gameengine/SceneGraph/SG_BBox.h index 08c242baf5d..5096d65558e 100644 --- a/source/gameengine/SceneGraph/SG_BBox.h +++ b/source/gameengine/SceneGraph/SG_BBox.h @@ -117,14 +117,14 @@ public: /** * Get the eight points that define this bounding box. * - * @param world a world transform to apply to the produced points bounding box. + * \param world a world transform to apply to the produced points bounding box. */ void get(MT_Point3 *box, const MT_Transform &world) const; /** * Get the eight points that define this axis aligned bounding box. * This differs from SG_BBox::get() in that the produced box will be world axis aligned. * The maximum & minimum local points will be transformed *before* splitting to 8 points. - * @param world a world transform to be applied. + * \param world a world transform to be applied. */ void getaa(MT_Point3 *box, const MT_Transform &world) const; diff --git a/source/gameengine/SceneGraph/SG_Controller.cpp b/source/gameengine/SceneGraph/SG_Controller.cpp index 5299c865992..07c89dd7af4 100644 --- a/source/gameengine/SceneGraph/SG_Controller.cpp +++ b/source/gameengine/SceneGraph/SG_Controller.cpp @@ -1,5 +1,4 @@ /* - * @file SG_Controller.cpp * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -30,7 +29,6 @@ * \ingroup bgesg */ - #include "SG_Controller.h" void @@ -46,5 +44,3 @@ ClearObject( ){ m_pObject = NULL; } - - diff --git a/source/gameengine/SceneGraph/SG_Controller.h b/source/gameengine/SceneGraph/SG_Controller.h index f6361d2c992..7100debe632 100644 --- a/source/gameengine/SceneGraph/SG_Controller.h +++ b/source/gameengine/SceneGraph/SG_Controller.h @@ -88,12 +88,12 @@ public: /** * Hacky way of passing options to specific controllers - * @param option An integer identifying the option. - * @param value The value of this option. - * @attention This has been placed here to give sca-elements - * @attention some control over the controllers. This is - * @attention necessary because the identity of the controller - * @attention is lost on the way here. + * \param option An integer identifying the option. + * \param value The value of this option. + * \attention This has been placed here to give sca-elements + * \attention some control over the controllers. This is + * \attention necessary because the identity of the controller + * \attention is lost on the way here. */ virtual void diff --git a/source/gameengine/SceneGraph/SG_Node.h b/source/gameengine/SceneGraph/SG_Node.h index 48bbe943892..41133495f2e 100644 --- a/source/gameengine/SceneGraph/SG_Node.h +++ b/source/gameengine/SceneGraph/SG_Node.h @@ -91,7 +91,7 @@ public: * Get the current list of children. Do not use this interface for * adding or removing children please use the methods of this class for * that. - * @return a reference to the list of children of this node. + * \return a reference to the list of children of this node. */ NodeList& GetSGChildren() @@ -101,7 +101,7 @@ public: /** * Get the current list of children. - * @return a const reference to the current list of children of this node. + * \return a const reference to the current list of children of this node. */ const NodeList& GetSGChildren() const diff --git a/source/gameengine/SceneGraph/SG_ParentRelation.h b/source/gameengine/SceneGraph/SG_ParentRelation.h index 07f11c87a36..77172256ef9 100644 --- a/source/gameengine/SceneGraph/SG_ParentRelation.h +++ b/source/gameengine/SceneGraph/SG_ParentRelation.h @@ -28,9 +28,9 @@ /** \file SG_ParentRelation.h * \ingroup bgesg - * @page SG_ParentRelationPage SG_ParentRelation + * \page SG_ParentRelationPage SG_ParentRelation - * @section SG_ParentRelationSection SG_ParentRelation + * \section SG_ParentRelationSection SG_ParentRelation * * This is an abstract interface class to the Scene Graph library. * It allows you to specify how child nodes react to parent nodes. diff --git a/source/gameengine/SceneGraph/SG_Tree.h b/source/gameengine/SceneGraph/SG_Tree.h index b0d74bedec5..dcca1a1442f 100644 --- a/source/gameengine/SceneGraph/SG_Tree.h +++ b/source/gameengine/SceneGraph/SG_Tree.h @@ -81,8 +81,8 @@ public: /** * Gets the eight corners of this treenode's bounding box, * in world coordinates. - * @param box: an array of 8 MT_Point3 - * @example MT_Point3 box[8]; + * \param box: an array of 8 MT_Point3 + * \example MT_Point3 box[8]; * treenode->get(box); */ void get(MT_Point3 *box) const; @@ -127,7 +127,7 @@ public: * It joins pairs of SG_Nodes to minimise the size of the resultant * bounding box. * cf building an optimised Huffman tree. - * @warning O(n^3)!!! + * \warning O(n^3)!!! */ class SG_TreeFactory { diff --git a/source/gameengine/VideoTexture/VideoFFmpeg.cpp b/source/gameengine/VideoTexture/VideoFFmpeg.cpp index 0ee2f23521c..aa8496431d9 100644 --- a/source/gameengine/VideoTexture/VideoFFmpeg.cpp +++ b/source/gameengine/VideoTexture/VideoFFmpeg.cpp @@ -844,7 +844,7 @@ void VideoFFmpeg::setPositions (void) m_startTime -= double(m_lastFrame) / actFrameRate(); else { m_startTime -= m_range[0]; - // start from begining, stop cache just in case + // start from beginning, stop cache just in case stopCache(); } } @@ -959,7 +959,7 @@ AVFrame *VideoFFmpeg::grabFrame(long position) // of the file. if (position <= m_preseek) { - // we can safely go the begining of the file + // we can safely go the beginning of the file if (av_seek_frame(m_formatCtx, m_videoStream, 0, AVSEEK_FLAG_BYTE) >= 0) { // binary seek does not reset the timestamp, must do it now |