aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2020-12-07 13:04:24 +0100
committerEelco Dolstra <edolstra@gmail.com>2020-12-21 13:32:23 +0100
commit346baec783a7423aa5b6cacaf7eebb8d22d4ce79 (patch)
treef09bcc9887b22a172a197d2394db357e4972682a
parent9fab14adbc3810d5cc1f88672fde1eee4358405c (diff)
Move doc() to Args
-rw-r--r--src/libutil/args.cc4
-rw-r--r--src/libutil/args.hh6
2 files changed, 5 insertions, 5 deletions
diff --git a/src/libutil/args.cc b/src/libutil/args.cc
index 61f9503ec..a929ea5ac 100644
--- a/src/libutil/args.cc
+++ b/src/libutil/args.cc
@@ -254,6 +254,8 @@ nlohmann::json Args::toJSON()
res["description"] = description();
res["flags"] = std::move(flags);
res["args"] = std::move(args);
+ auto s = doc();
+ if (s != "") res.emplace("doc", stripIndentation(s));
return res;
}
@@ -378,8 +380,6 @@ nlohmann::json Command::toJSON()
auto res = Args::toJSON();
res["examples"] = std::move(exs);
- auto s = doc();
- if (s != "") res.emplace("doc", stripIndentation(s));
return res;
}
diff --git a/src/libutil/args.hh b/src/libutil/args.hh
index 8069fd70f..68bbbb4f7 100644
--- a/src/libutil/args.hh
+++ b/src/libutil/args.hh
@@ -25,6 +25,9 @@ public:
/* Return a short one-line description of the command. */
virtual std::string description() { return ""; }
+ /* Return documentation about this command, in Markdown format. */
+ virtual std::string doc() { return ""; }
+
protected:
static const size_t ArityAny = std::numeric_limits<size_t>::max();
@@ -225,9 +228,6 @@ struct Command : virtual Args
virtual void prepare() { };
virtual void run() = 0;
- /* Return documentation about this command, in Markdown format. */
- virtual std::string doc() { return ""; }
-
struct Example
{
std::string description;