Metadata-Version: 2.1
Name: cdox
Version: 0.0.1
Summary: automate documentation of c projects
Home-page: https://github.com/breakthatbass/cdox
Author: Taylor Gamache
Author-email: gamache.taylor@gmail.com
License: MIT
Description: # cdox
        
        a script to automate documentation of your C APIs in markdown format.  
        
        `cdox` reads in a source code file creates documentation based on the comments. it's sort of like doxygen but simpler and just creates a markdown file which looks good on github.  
        
        ## usage
        ```
        cdox infile outfile
        ```
        
        ## installation
        ```
        git clone https://github.com/breakthatbass/cdox.git
        pip install .
        ```
        
        ## rules 
        
        **cdox keywords:**
        - `@name:` name of documentation
        - `@description` description of file documentation
        - `@param:` a bullet point for info on a function paramter
        - `@return:` a bullet point for what the function returns
        
        **rules:**
        - the keywords must be in multiline comments. 
        - the multiline comments must start with `/* *` and end with `* */` each on their own line.
        - the function name/protoype must be on the line following the `* */`
        
        ## todo
        - add it as a package to pypi
        - add feature to allow making section headers
        - add @global keyword for documentation of global variables
        
        ## example
        Below is an excerpt from [`test.c`](https://github.com/breakthatbass/cdox/blob/main/tests/test.c) which would create the doc below. For the full example doc, check out [`example.md](https://github.com/breakthatbass/cdox/blob/main/example.md)
        ```C
        /* *
         * strncmp
         * 
         * @desc: compare two strings up to `n` characters.
         * 
         * @param: `s1` - a char array of at least one char.
         * @param: `s2` - a char array of at least one char.
         * @param: `n` - the number of chars to compare of each string.
         * 
         * @return: 0 if strings are the same else a non-zero int.
         * */
        int strncmp(const char *s1, const char *s2, int n)
        {
          while(n > 0 && *s1 == *s2++) {
            if(*s1++ == '\0')
              return 0;
            n--;
          }
          return (n == 0 ? 0 : *s1 - *--s2);
        }
        ```
        #
        ```C
        int strncmp(const char *s1, const char *s2, int n) 
        ```
        compare two strings up to `n` characters.
        - `s1` - a char array of at least one char.
        - `s2` - a char array of at least one char.
        - `n` - the number of chars to compare of each string.
        - **returns** 0 if strings are the same else a non-zero int.
Platform: UNKNOWN
Description-Content-Type: text/markdown
