From: Heba Waly via GitGitGadget <gitgitgadget@gmail.com>
Date: Sun, 17 Nov 2019 21:04:54 GMT
Subject: [PATCH v5 15/21] parse-options: add link to doc file in parse-options.h
Message-ID: <0e9e89fd8380f3f2a3b89ad02a05f87ea2251f1d.1574024701.git.gitgitgadget@gmail.com>
In-Reply-To: <pull.434.v5.git.1574024700.gitgitgadget@gmail.com>

From: Heba Waly <heba.waly@gmail.com>

Add a link to Documentation/technical/api-parse-options.txt in parse-options.h
So the developers would know where to find more info about the API.

Signed-off-by: Heba Waly <heba.waly@gmail.com>
---
 parse-options.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/parse-options.h b/parse-options.h
index 38a33a087e..164ec566b0 100644
--- a/parse-options.h
+++ b/parse-options.h
@@ -1,6 +1,10 @@
 #ifndef PARSE_OPTIONS_H
 #define PARSE_OPTIONS_H
 
+/**
+ * Refer to Documentation/technical/api-parse-options.txt for the API doc.
+ */
+
 enum parse_opt_type {
 	/* special types */
 	OPTION_END,
-- 
gitgitgadget