From 242de17703568eca9b50853348e0da0af5efdb3e Mon Sep 17 00:00:00 2001 From: Jiri Vlasak Date: Fri, 3 Jul 2020 14:46:40 +0200 Subject: [PATCH] Document public functions --- api/bcar.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/api/bcar.h b/api/bcar.h index adbe631..0dffda2 100644 --- a/api/bcar.h +++ b/api/bcar.h @@ -1,3 +1,4 @@ +/*! \file */ #ifndef BCAR_H #define BCAR_H @@ -269,7 +270,7 @@ intersect( double x2, double y2 ); -/* \brief Return the smallest angle between three points. +/*! \brief Return the smallest angle between three points. \see https://math.stackexchange.com/questions/361412/finding-the-angle-between-three-points @@ -287,7 +288,7 @@ angle_between_three_points( double x3, double y3 ); -/* \brief Return if point is on the right side of plane. +/*! \brief Return if point is on the right side of plane. \param x1 Line first `x` coordinate. \param y1 Line first `y` coordinate. -- 2.39.2