doc/API #9916

1 files changed, 13 insertions, 0 deletions

diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index f54ac5072c..390f1bbddb 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -1198,12 +1198,25 @@ void nvim_unsubscribe(uint64_t channel_id, String event)
   rpc_unsubscribe(channel_id, e);
 }
 
+/// If the given name is an hexadecimal value (e.g. #XXXXXX)
+/// translates it to RGB. Otherwise, translates given name
+/// (e.g. “Pink”) to its RGB value. Returns -1 if it wasn’t
+/// able to find a correct RGB value for the given color name.
+///
+/// @param name Color name string
+/// @return A 24-bit RGB value of the given name or -1 if it wasn’t able
+///         to find a correct RGB value for the given color name.
 Integer nvim_get_color_by_name(String name)
   FUNC_API_SINCE(1)
 {
   return name_to_color((char_u *)name.data);
 }
 
+/// Returns a map (dictionary) with all colors from rgb.txt.
+/// Every key in the map is a color name (e.g. “Aqua”), and every
+/// value is a 24-bit RGB value (e.g. 65535).
+///
+/// @return Map associating names of colors and color RGB values.
 Dictionary nvim_get_color_map(void)
   FUNC_API_SINCE(1)
 {