From 2109dedc473944dbb38756cd48d0c44f996304c4 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Wed, 9 Aug 2023 08:54:37 +0200
Subject: Complete and cleanup function documentation in preparation for
 auto-extraction

Also:

- Move the $target.*() function family from functions-name.cxx to separate
  functions-target.cxx.

- Get rid of the separate $process_path_ex.*() family, merging it with
  $process_path.*().
---
 libbuild2/functions-target-triplet.cxx | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'libbuild2/functions-target-triplet.cxx')

diff --git a/libbuild2/functions-target-triplet.cxx b/libbuild2/functions-target-triplet.cxx
index b89cadf..6e12c97 100644
--- a/libbuild2/functions-target-triplet.cxx
+++ b/libbuild2/functions-target-triplet.cxx
@@ -13,6 +13,12 @@ namespace build2
   {
     function_family f (m, "target_triplet");
 
+    // $string(<target-triplet>)
+    //
+    // Return the canonical (that is, without the `unknown` vendor component)
+    // target triplet string.
+    //
+
     // Note that we must handle NULL values (relied upon by the parser
     // to provide conversion semantics consistent with untyped values).
     //
@@ -21,6 +27,11 @@ namespace build2
       return t != nullptr ? t->string () : string ();
     };
 
+    // $representation(<target-triplet>)
+    //
+    // Return the complete target triplet string that always contains the
+    // vendor component.
+    //
     f["representation"] += [](target_triplet t)
     {
       return t.representation ();
-- 
cgit v1.1