From 58ef3c75bb5c5011267ee32f177228c9c6d0c36a Mon Sep 17 00:00:00 2001
From: Nyall Dawson <nyall.dawson@gmail.com>
Date: Wed, 17 Aug 2016 15:34:55 +1000
Subject: [PATCH] Add missing doc

---
 src/core/pal/feature.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/core/pal/feature.h b/src/core/pal/feature.h
index 10e908d7f48..c766e281a8a 100644
--- a/src/core/pal/feature.h
+++ b/src/core/pal/feature.h
@@ -177,6 +177,15 @@ namespace pal
        */
       int createCandidatesAlongLineNearMidpoint( QList<LabelPosition *> &lPos, PointSet *mapShape, double initialCost = 0.0 );
 
+      /** Returns the label position for a curved label at a specific offset along a path.
+       * @param path_positions line path to place label on
+       * @param path_distances array of distances to each segment on path
+       * @param orientation can be 0 for automatic calculation of orientation, or -1/+1 for a specific label orientation
+       * @param index
+       * @param distance distance to offset label along curve by
+       * @param flip
+       * @returns calculated label position
+       */
       LabelPosition* curvedPlacementAtOffset( PointSet* path_positions, double* path_distances,
                                               int& orientation, int index, double distance, bool& flip );