From 62222c2f5b3ba673caa2f6bec4a13874ef8f2eb3 Mon Sep 17 00:00:00 2001
From: Ylva Selling <ys5140@nyu.edu>
Date: Tue, 26 Apr 2022 17:39:38 -0400
Subject: [PATCH] Add descriptions of lua functions

---
 modules/skybrowser/skybrowsermodule_lua.inl | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/modules/skybrowser/skybrowsermodule_lua.inl b/modules/skybrowser/skybrowsermodule_lua.inl
index 2b5607a4f1..f49b07fcec 100644
--- a/modules/skybrowser/skybrowsermodule_lua.inl
+++ b/modules/skybrowser/skybrowsermodule_lua.inl
@@ -655,22 +655,25 @@ namespace {
  * Takes an identifier to a sky browser and adds a rendered copy to it.
  * \param raePosition Position in radius, azimuth, elevation coordinates
  * \param nCopies Number of copies
+ * \param position Position of first copy, which depends on if RAE or Cartesian coordinates
+ * are checked
  */
 [[codegen::luawrap]] void addRenderCopy(std::string identifier,
                                         int numberOfCopies = 1,
-                     glm::vec3 radiusAzimuthElevationPosition = glm::vec3(2.1f, 0.f, 0.f))
+                     glm::vec3 position = glm::vec3(2.1f, 0.f, 0.f))
 {
     using namespace openspace;
 
     SkyBrowserModule* module = global::moduleEngine->module<SkyBrowserModule>();
     TargetBrowserPair* pair = module->getPair(identifier);
     if (pair) {
-        pair->browser()->addRenderCopy(radiusAzimuthElevationPosition, numberOfCopies);
+        pair->browser()->addRenderCopy(position, numberOfCopies);
     }
 }
 
 /**
  * Takes an identifier to a sky browser and removes the latest added rendered copy to it.
+ * \param identifier Identifier of the sky browser
  */
 [[codegen::luawrap]] void removeRenderCopy(std::string identifier) {
     using namespace openspace;
@@ -684,6 +687,7 @@ namespace {
 
 /**
  * Starts the fine-tuning of the target rendered copy to it.
+ * \param identifier Identifier of the sky browser
  */
 [[codegen::luawrap]] void startFinetuningTarget(std::string identifier) {
     using namespace openspace;
@@ -697,6 +701,9 @@ namespace {
 
 /**
  * Finetunes the target depending on a mouse drag. rendered copy to it.
+ * \param identifier Identifier of the sky browser
+ * \param startPosition Start position of the mouse click drag for the fine tune vector 
+ * \param endPosition End position of the mouse click drag for the fine tune vector 
  */
 [[codegen::luawrap]] void finetuneTargetPosition(std::string identifier,
                                                  glm::vec2 startPosition,
@@ -716,6 +723,7 @@ namespace {
 
 /**
  * Sets the image collection as loaded in the sky browser
+ * \param identifier Identifier of the sky browser
  */
 [[codegen::luawrap]] void loadingImageCollectionComplete(std::string identifier) {
     using namespace openspace;