Add documentation for all data structures and algorithmic functions

[faheel]

Add a README to each directory containing proper documentation for algorithms or data structures in that directory.

[sriram-25]

What all should the documentation contain? For eg. Time Complexity,Working of the Algorithm?
@faheel

[faheel]

For now the documentation will not include the working details of the algorithm but only information about the "interface" of various functions, i.e. about:

• what the function does,
• its inputs,
• its output (return value), if any,

along with (wherever necessary),

• time complexity,
• space complexity.

The inputs, variables and output will have their type, name and a single line description. The time and space complexity will be of the best and worst cases (and average case too, if necessary).

For example, for Kadane.cpp the documentation could look like:

---

maximumSubarray

<description of what the function does in 1-2 lines>

Input

• values

  Type: const vector<int> &

  <description in 1-2 lines>

Output

• tuple of maxSum, start, end

  Type: tuple<int, size_t, size_t>

  <description of maxSum in 1-2 lines>
  <description of start in 1-2 lines>
  <description of end in 1-2 lines>

Time complexity

• Worst case

  O(N), where N is the size of values

• Best case

  O(N), where N is the size of values

---

Markdown for the above documentation:

## `maximumSubarray`
<description of what the function does in 1-2 lines>

### Input
- #### `values`
  Type: `const vector<int> &`

  <description in 1-2 lines>

### Output
- #### tuple of `maxSum`, `start`, `end`
  Type: `tuple<int, size_t, size_t>`

  <description of `maxSum` in 1-2 lines>
  <description of `start` in 1-2 lines>
  <description of `end` in 1-2 lines>

### Time complexity
- #### Worst case
  _O_(**N**), where **N** is the size of `values`
- #### Best case
  _O_(**N**), where **N** is the size of `values`

[faheel]

Issue #74 is now closed

[faheel]

This task can be automated using Doxygen.

[stale]

This issue has been automatically marked as inactive because it has not had recent activity. It will be closed in 15 days if no further activity occurs. Thank you for your contributions.