From 870ab60d2f3910dfe42d0dbb94d1bc9e59aa25cd Mon Sep 17 00:00:00 2001 From: github-actions <${GITHUB_ACTOR}@users.noreply.github.com> Date: Thu, 9 Jul 2020 22:17:49 +0000 Subject: [PATCH] Documentation for 497d627ebde140b14dde08e25d98b7049886601d --- d5/d88/md__d_i_r_e_c_t_o_r_y.html | 36 ++++----- d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html | 103 +++++++++++++++++++----- index.html | 8 +- navtreedata.js | 65 +++++++-------- navtreeindex1.js | 46 +++++------ navtreeindex2.js | 12 +-- navtreeindex3.js | 6 +- navtreeindex4.js | 11 +-- 8 files changed, 178 insertions(+), 109 deletions(-) diff --git a/d5/d88/md__d_i_r_e_c_t_o_r_y.html b/d5/d88/md__d_i_r_e_c_t_o_r_y.html index ba72d406d..e0670c862 100644 --- a/d5/d88/md__d_i_r_e_c_t_o_r_y.html +++ b/d5/d88/md__d_i_r_e_c_t_o_r_y.html @@ -94,7 +94,7 @@ $(document).ready(function(){initNavTree('d5/d88/md__d_i_r_e_c_t_o_r_y.html','..
List of all files
-

+

Backtracking

  • Rat Maze
  • Sudoku Solve
    • -

    +

    Ciphers

    -

    +

    Data Structures

    -

    +

    Dynamic Programming

    -

    +

    Geometry

    -

    +

    Graph

    -

    +

    Greedy Algorithms

    -

    +

    Hashing

    -

    +

    Machine Learning

    -

    +

    Math

    -

    +

    Numerical Methods

    -

    +

    Operations On Datastructures

    -

    +

    Others

    -

    +

    Probability

    -

    +

    Range Queries

    -

    +

    Search

    -

    +

    Sorting

    -

    +

    Strings

    +Documentation

    + +

    +Test

    + +

    +Typical structure of a program:

    +
    /**
    +
    * @file
    +
    * @brief Add one line description here
    +
    * @details
    +
    * This is a multi line
    +
    * description containing links, references,
    +
    * math equations, etc
    +
    * @author [Name](https://github.com/handle)
    +
    * @see related_file.cpp, another_file.cpp
    +
    */
    +
    +
    #include
    +
    +
    /**
    +
    * @namespace <check from other files in this repo>
    +
    */
    +
    namespace name {
    +
    +
    /**
    +
    * Class documentation
    +
    */
    +
    class cls_name{
    +
    private:
    +
    int var1; ///< short info of this variable
    +
    char *msg; ///< short info
    +
    +
    public:
    +
    // other members also documented as below
    +
    }
    +
    +
    /**
    +
    * Function documentation
    +
    * @tparam T this is a one-line info about T
    +
    * @param param1 on-line info about param1
    +
    * @param param2 on-line info about param2
    +
    * @returns `true` if ...
    +
    * @returns `false` if ...
    +
    */
    +
    template<class T>
    +
    bool func(int param1, T param2) {
    +
    // function statements here
    +
    if(/*something bad*/)
    +
    return false;
    +
    +
    return true;
    +
    }
    +
    +
    /** Test function */
    +
    void test() {
    +
    /* some statements */
    +
    assert(func(...) == ...); // this ensures that the algorithm works as expected
    +
    +
    // can have multiple checks
    +
    }
    +
    +
    /** Main function */
    +
    int main(int argc, char *argv[]) {
    +
    // code here
    +
    return 0;
    +
    }
    +

    New File Name guidelines

    -

    +

    New Directory guidelines

    -

    +

    Commit Guidelines

    -

    -Documentation

    - -

    -Test

    - -

    +

    Pull Requests

    -

    +

    cpplint

    To see if cpplint is already installed, do:

    +
    main
    int main()
    Definition: hill_cipher.cpp:532
    +
    test
    void test()
    Definition: armstrong_number.cpp:59