Skip to content

Commit

Permalink
feat(README): Add description and supported-languages section
Browse files Browse the repository at this point in the history
  • Loading branch information
kkoomen committed May 11, 2019
1 parent 6588e53 commit 900a9f0
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,40 @@
# doge
# DoGe

[TODO]
We all love documentation because it makes our codebases easier to understand,
yet no one has time to write it in a good and proper way or likes to write it.

DoGe is a DOcumentation GEnerator which will generate proper documentation based
on the function declaration. You can simply put your cursor on a function, press
`<C-d>`(<kbd>Ctrl</kbd> + <kbd>d</kbd>) and go on coding!

*(In progress)* DoGe is also able to update an existing generated doc-comment which allows you
to add, modify or delete a parameter, press `<C-d>` again and the corresponding
doc-comment has been updated.

*NOTE: The comment will be replaced for now rather then updated properly, this
means that additional commentary being added will be removed as well when
generating the comment again.*

### Supported languages and doc standards

- [x] Python ([Sphinx reST](http://daouzli.com/blog/docstring.html#restructuredtext))
- [x] PHP ([phpdoc](https://www.phpdoc.org))
- [ ] Javascript ([JSDoc](https://jsdoc.app))

# Table of Contents
- [doge](#doge)
- [DoGe](#doge)
+ [Supported languages and doc standards](#supported-languages-and-doc-standards)
- [Table of Contents](#table-of-contents)
- [Getting Started](#getting-started)
- [Configuration](#configuration)
- [Contributing](#contributing)
* [Linting](#linting)
* [Documentation](#documentation)
- [License](#license)

# Getting Started

Install `doge`:
Install `DoGe`:

Using vim-pack:

Expand Down

0 comments on commit 900a9f0

Please sign in to comment.