From 009c4737332f1e72403afcf5d9198ec5e06b0349 Mon Sep 17 00:00:00 2001 From: Bert Timmerman Date: Thu, 29 Dec 2011 13:10:12 +0100 Subject: [PATCH 1/1] src/box.h: Converted plain comments into doxygen comments. --- src/box.h | 28 +++++++++++++++++++++------- 1 files changed, 21 insertions(+), 7 deletions(-) diff --git a/src/box.h b/src/box.h index 943b316..038bd18 100644 --- a/src/box.h +++ b/src/box.h @@ -173,7 +173,10 @@ bloat_box (const BoxType * box, Coord amount) return shrink_box (box, -amount); } -/* construct a minimum box that touches the input box at the center */ +/*! + * \brief Construct a minimum box that touches the input box at the + * center. + */ static inline BoxType box_center (const BoxType * box) { @@ -185,7 +188,10 @@ box_center (const BoxType * box) return r; } -/* construct a minimum box that touches the input box at the corner */ +/*! + * \brief Construct a minimum box that touches the input box at the + * corner. + */ static inline BoxType box_corner (const BoxType * box) { @@ -197,7 +203,9 @@ box_corner (const BoxType * box) return r; } -/* construct a box that holds a single point */ +/*! + * \brief Construct a box that holds a single point. + */ static inline BoxType point_box (Coord X, Coord Y) { @@ -209,7 +217,9 @@ point_box (Coord X, Coord Y) return r; } -/* close a bounding box by pushing its upper right corner */ +/*! + * \brief Close a bounding box by pushing its upper right corner. + */ static inline void close_box (BoxType * r) { @@ -217,9 +227,13 @@ close_box (BoxType * r) r->Y2++; } -/* return the square of the minimum distance from a point to some point - * inside a box. The box is half-closed! That is, the top-left corner - * is considered in the box, but the bottom-right corner is not. */ +/*! + * \brief return the square of the minimum distance from a point to some + * point inside a box. + * + * The box is half-closed! That is, the top-left corner is considered + * in the box, but the bottom-right corner is not. + */ static inline double dist2_to_box (const CheapPointType * p, const BoxType * b) { -- 1.7.3.4