Update README.md
This commit is contained in:
bryant-the-coder
96
README.md
96
README.md
@@ -1,23 +1,27 @@
|
||||
<div align="center">
|
||||
<img src="https://user-images.githubusercontent.com/5306901/141127528-ddff21bb-8da3-43da-8efe-9494a4f231d2.png" width=250><br>
|
||||
|
||||
|
||||
# Neogen - Your Annotation Toolkit
|
||||
|
||||
[](https://neovim.io)
|
||||
[](http://www.lua.org)
|
||||
|
||||
</div>
|
||||
|
||||
# Table Of Contents
|
||||
|
||||
* [Features](#features)
|
||||
* [Requirements](#requirements)
|
||||
* [Installation](#installation)
|
||||
* [Usage](#usage)
|
||||
* [Configuration](#configuration)
|
||||
* [Supported Languages](#supported-languages)
|
||||
* [Adding Languages](#adding-languages)
|
||||
* [GIFS](#gifs)
|
||||
|
||||
- [Neogen - Your Annotation Toolkit](#neogen---your-annotation-toolkit)
|
||||
- [Table Of Contents](#table-of-contents)
|
||||
- [Features](#features)
|
||||
- [Requirements](#requirements)
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
- [Cycle between annotations](#cycle-between-annotations)
|
||||
- [Configuration](#configuration)
|
||||
- [Supported Languages](#supported-languages)
|
||||
- [Adding Languages](#adding-languages)
|
||||
- [GIFS](#gifs)
|
||||
- [Credits](#credits)
|
||||
|
||||
## Features
|
||||
|
||||
@@ -37,8 +41,8 @@
|
||||
Use your favorite package manager to install Neogen, e.g:
|
||||
|
||||
```lua
|
||||
use {
|
||||
"danymat/neogen",
|
||||
use {
|
||||
"danymat/neogen",
|
||||
config = function()
|
||||
require('neogen').setup {
|
||||
enabled = true
|
||||
@@ -55,10 +59,10 @@ use {
|
||||
```vim
|
||||
" will generate annotation for the function you're inside
|
||||
:Neogen
|
||||
" or you can force a certain type of annotation.
|
||||
" or you can force a certain type of annotation.
|
||||
" It'll find the next upper node that matches the type
|
||||
" E.g if you're on a method of a class and do `:Neogen class`, it'll find the class declaration and generate the annotation.
|
||||
:Neogen func|class|type|...
|
||||
:Neogen func|class|type|...
|
||||
```
|
||||
|
||||
- If you like to use the lua API, I exposed a function to generate the annotations.
|
||||
@@ -107,7 +111,7 @@ If you want to use a key that's already used for completion purposes, take a loo
|
||||
|
||||
<details>
|
||||
<summary>nvim-cmp</summary>
|
||||
|
||||
|
||||
```lua
|
||||
local cmp = require('cmp')
|
||||
local neogen = require('neogen')
|
||||
@@ -180,41 +184,39 @@ require('neogen').setup {
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Check out `:h neogen-advanced_configurations` for more information !
|
||||
|
||||
## Supported Languages
|
||||
|
||||
There is a list of supported languages and fields, with their annotation style
|
||||
|
||||
| Language | Annotation conventions | Supported fields | Supported annotation types
|
||||
|---|---|---|---|
|
||||
| lua | | | `func`, `class`, `type`, `file` |
|
||||
| | [Emmylua](https://emmylua.github.io/) (`"emmylua"`) | `@param`, `@varargs`, `@return`, `@class`, `@type`, `@module` |
|
||||
| | [Ldoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html) (`"ldoc"`) | `@param`, `@varargs`, `@return`, `@class`, `@type` |
|
||||
| python | | | `func`, `class`, `file`, `type` |
|
||||
| | [Google docstrings](https://google.github.io/styleguide/pyguide.html) (`"google_docstrings"`) | `Args`, `Attributes`, `Returns` |
|
||||
| | [Numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) (`"numpydoc"`)| `Arguments`, `Attributes`, `Returns`|
|
||||
| javascript | | | `func`, `class`, `file`, `type`|
|
||||
| | [JSDoc](https://jsdoc.app) (`"jsdoc"`) | `@param`, `@returns`, `@class`, `@classdesc`, `@module`, `@type`|
|
||||
| typescript | | | `func`, `class`, `file`, `type` |
|
||||
| | [JSDoc](https://jsdoc.app) (`"jsdoc"`) | `@param`, `@returns`, `@class`, `@classdesc`, `@type`, `@module`|
|
||||
| c | | | `func`, `file`|
|
||||
| | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@param`, `@return`, `@brief`, `@file`|
|
||||
| cpp | | | `func`, `file`, `class`|
|
||||
| | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@param`, `@return`, `@tparam`, `@brief`, `@file`, `@class`|
|
||||
| go | | | `func`, `type` |
|
||||
| | [Godoc](https://go.dev/blog/godoc) (`"godoc"`) | |
|
||||
| java | | | `func`, `class` |
|
||||
| | [Javadoc](https://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#documentationcomments) (`"javadoc"`) | `@param`, `@return`, `@throws`|
|
||||
| rust | | | `func`, `file`, `class` |
|
||||
| | [Rustdoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) (`"rustdoc"`) | |
|
||||
| | [Alternative](https://stackoverflow.com/questions/30009650/how-do-you-document-function-arguments) (`"alternative"`) | |
|
||||
| csharp | | | `func`, `file`, `class`|
|
||||
| | [Xmldoc](https://docs.microsoft.com/fr-fr/dotnet/csharp/language-reference/xmldoc/) (`"xmldoc"`) | `<summary>`, `<param>`,`<returns>`|
|
||||
| | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@param`, `@return`, `@brief`|
|
||||
| php | | | `func`, `type`, `class` |
|
||||
| | [Php-doc](https://docs.phpdoc.org/3.0/guide/references/phpdoc/index.html) (`"phpdoc"`) | `@var`, `@param`, `@return` |
|
||||
| Languages | Annotation Conventions | Supported annotation types |
|
||||
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| lua | [Emmylua](https://emmylua.github.io/) (`"emmylua"`) | `@func`, `@class`, `@type`, `@file` |
|
||||
| | [Ldoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html) (`"ldoc"`) | |
|
||||
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | |
|
||||
| python | [Google docstrings](https://google.github.io/styleguide/pyguide.html) (`"google_docstrings"`) | |
|
||||
| | [Numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) (`"numpydoc"`) | |
|
||||
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | |
|
||||
| javascript | [JSDoc](https://jsdoc.app) (`"jsdoc"`) | |
|
||||
| typescript | | |
|
||||
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| c | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@func`, `@file` |
|
||||
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| cpp | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@func`, `@file`, `@class` |
|
||||
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| go | [GoDoc](https://go.dev/blog/godoc) (`"godoc"`) | `@func`, `@type` |
|
||||
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
|
||||
| java | [Javadoc](https://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#documentationcomments) (`"javadoc`) | `@func`, `@class` |
|
||||
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| rust | [RustDoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) (`"rustdoc"`) | `@func`, `@file`, `@class` |
|
||||
| | [Alternative](https://stackoverflow.com/questions/30009650/how-do-you-document-function-arguments) (`"alternative"`) | |
|
||||
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | |
|
||||
| csharp | [Xmldoc](https://docs.microsoft.com/fr-fr/dotnet/csharp/language-reference/xmldoc/) (`"xmldoc"`) | |
|
||||
| | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | |
|
||||
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| php | [Ph-doc](https://docs.phpdoc.org/3.0/guide/references/phpdoc/index.html) (`"phpdoc"`) | `@func`, `@type`, `@class` |
|
||||
|
||||
## Adding Languages
|
||||
|
||||
@@ -226,11 +228,11 @@ There is a list of supported languages and fields, with their annotation style
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Credits
|
||||
|
||||
- Binx, for making that gorgeous logo for free!
|
||||
- [Github](https://github.com/Binx-Codes/)
|
||||
- [Reddit](https://www.reddit.com/u/binxatmachine)
|
||||
- [Github](https://github.com/Binx-Codes/)
|
||||
- [Reddit](https://www.reddit.com/u/binxatmachine)
|
||||
|
||||
Reference in New Issue
Block a user