From a5de82aaa87bee699bb027b30f3bab51c4989a18 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Beat=20K=C3=BCng?= <beat-kueng@gmx.net>
Date: Mon, 6 Aug 2018 15:51:25 +0200
Subject: [PATCH] cmake: add documentation for px4_posix_generate_alias and
 px4_posix_generate_symlinks

---
 platforms/posix/cmake/px4_impl_os.cmake | 47 +++++++++++++++++++++++--
 1 file changed, 45 insertions(+), 2 deletions(-)

diff --git a/platforms/posix/cmake/px4_impl_os.cmake b/platforms/posix/cmake/px4_impl_os.cmake
index 3c6faa944d..b8e0abf823 100644
--- a/platforms/posix/cmake/px4_impl_os.cmake
+++ b/platforms/posix/cmake/px4_impl_os.cmake
@@ -104,7 +104,30 @@ function(px4_posix_generate_builtin_commands)
 endfunction()
 
 
-# TODO: document API
+#=============================================================================
+#
+#	px4_posix_generate_alias
+#
+#	This function generates the px4-alias.sh script containing the command
+#	aliases for all modules and commands.
+#
+#	Usage:
+#		px4_posix_generate_alias(
+#			MODULE_LIST <in-list>
+#			OUT <file>
+#			PREFIX <prefix>)
+#
+#	Input:
+#		MODULE_LIST	: list of modules
+#		PREFIX	: command prefix (e.g. "px4-")
+#
+#	Output:
+#		OUT	: px4-alias.sh file path
+#
+#	Example:
+#		px4_posix_generate_alias(
+#			OUT <generated-src> MODULE_LIST px4_simple_app PREFIX px4-)
+#
 function(px4_posix_generate_alias)
 	px4_parse_function_args(
 		NAME px4_posix_generate_alias
@@ -133,7 +156,27 @@ function(px4_posix_generate_alias)
 endfunction()
 
 
-# TODO: document API
+#=============================================================================
+#
+#	px4_posix_generate_symlinks
+#
+#	This function generates symlinks for all modules/commands.
+#
+#	Usage:
+#		px4_posix_generate_symlinks(
+#			TARGET <target>
+#			MODULE_LIST <in-list>
+#			PREFIX <prefix>)
+#
+#	Input:
+#		MODULE_LIST	: list of modules
+#		PREFIX	: command prefix (e.g. "px4-")
+#		TARGET	: cmake target for which the symlinks should be created
+#
+#	Example:
+#		px4_posix_generate_symlinks(
+#			TARGET px4 MODULE_LIST px4_simple_app PREFIX px4-)
+#
 function(px4_posix_generate_symlinks)
 	px4_parse_function_args(
 		NAME px4_posix_generate_symlinks