From 5ab43ad039f9aa943e596f6e47d26a36a1fb42a0 Mon Sep 17 00:00:00 2001
From: Krishna Vedala <krishna.vedala@ieee.org>
Date: Thu, 28 May 2020 20:41:31 -0400
Subject: [PATCH] document linear search

---
 search/linear_search.cpp | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/search/linear_search.cpp b/search/linear_search.cpp
index 8849549e5..142506951 100644
--- a/search/linear_search.cpp
+++ b/search/linear_search.cpp
@@ -1,5 +1,18 @@
+/**
+ * \file
+ * \brief [Linear search
+ * algorithm](https://en.wikipedia.org/wiki/Linear_search)
+ */
 #include <iostream>
 
+/**
+ * Algorithm implementation
+ * \param [in] array array to search in
+ * \param [in] size length of array
+ * \param [in] key key value to search for
+ * \returns index where the key-value occurs in the array
+ * \returns -1 if key-value not found
+ */
 int LinearSearch(int *array, int size, int key) {
     for (int i = 0; i < size; ++i) {
         if (array[i] == key) {
@@ -10,6 +23,7 @@ int LinearSearch(int *array, int size, int key) {
     return -1;
 }
 
+/** main function */
 int main() {
     int size;
     std::cout << "\nEnter the size of the Array : ";