diff options
| author | Campbell Barton <ideasman42@gmail.com> | 2018-12-12 04:55:20 +0300 |
|---|---|---|
| committer | Campbell Barton <ideasman42@gmail.com> | 2018-12-12 05:02:09 +0300 |
| commit | 49490e5cfbeb2b0b823aa2042401891001870a6e (patch) | |
| tree | a1d32562af2dea0c336ebd3d017a387834e936cc /source/blender/blenlib/intern/astar.c | |
| parent | 16fc62e15f0a749d6d64e784ea048e07d6ea3397 (diff) | |
| parent | e757c4a3bec8b0e8d198531a28327332af00a9ba (diff) | |
Merge branch 'master' into blender2.8
Diffstat (limited to 'source/blender/blenlib/intern/astar.c')
| -rw-r--r-- | source/blender/blenlib/intern/astar.c | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/source/blender/blenlib/intern/astar.c b/source/blender/blenlib/intern/astar.c index 30ad6c7838c..ff4dfea2401 100644 --- a/source/blender/blenlib/intern/astar.c +++ b/source/blender/blenlib/intern/astar.c @@ -62,7 +62,7 @@ /** * Init a node in A* graph. * - * \param custom_data an opaque pointer attached to this link, available e.g. to cost callback function. + * \param custom_data: an opaque pointer attached to this link, available e.g. to cost callback function. */ void BLI_astar_node_init(BLI_AStarGraph *as_graph, const int node_index, void *custom_data) { @@ -72,8 +72,8 @@ void BLI_astar_node_init(BLI_AStarGraph *as_graph, const int node_index, void *c /** * Add a link between two nodes of our A* graph. * - * \param cost the 'length' of the link (actual distance between two vertices or face centers e.g.). - * \param custom_data an opaque pointer attached to this link, available e.g. to cost callback function. + * \param cost: the 'length' of the link (actual distance between two vertices or face centers e.g.). + * \param custom_data: an opaque pointer attached to this link, available e.g. to cost callback function. */ void BLI_astar_node_link_add( BLI_AStarGraph *as_graph, const int node1_index, const int node2_index, const float cost, void *custom_data) @@ -104,7 +104,7 @@ int BLI_astar_node_link_other_node(BLI_AStarGNLink *lnk, const int idx) /** * Initialize a solution data for given A* graph. Does not compute anything! * - * \param custom_data an opaque pointer attached to this link, available e.g. to cost callback function. + * \param custom_data: an opaque pointer attached to this link, available e.g. to cost callback function. * * \note BLI_AStarSolution stores nearly all data needed during solution compute. */ @@ -169,7 +169,7 @@ void BLI_astar_solution_free(BLI_AStarSolution *as_solution) * * Nodes might be e.g. vertices, faces, ... * - * \param custom_data an opaque pointer attached to this link, available e.g. to cost callback function. + * \param custom_data: an opaque pointer attached to this link, available e.g. to cost callback function. */ void BLI_astar_graph_init(BLI_AStarGraph *as_graph, const int node_num, void *custom_data) { @@ -198,7 +198,7 @@ void BLI_astar_graph_free(BLI_AStarGraph *as_graph) /** * Solve a path in given graph, using given 'cost' callback function. * - * \param max_steps maximum number of nodes the found path may have. Useful in performance-critical usages. + * \param max_steps: maximum number of nodes the found path may have. Useful in performance-critical usages. * If no path is found within given steps, returns false too. * \return true if a path was found, false otherwise. */ |