leigh/neogen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docgen] Update doc/neogen.txt

Browse Source 
skip-checks: true
This commit is contained in:
github-actions
2022-01-11 15:48:32 +00:00
parent 6b01357b60
commit 689646fb6a
1 changed files with 90 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
doc/neogen.txt
View File

@@ -8,9 +8,10 @@ CONTENTS *neogen-content
1. Abstract......................................................|neogen-abstract|
2. Concept........................................................|neogen-concept|
3. Usage............................................................|neogen-usage|
4. Lua API........................................................|neogen-lua_api|
5. Config..........................................................|neogen-config|
4. Basic configurations..............................|neogen-basic_configurations|
5. Advanced configurations........................|neogen-advanced_configurations|
6. Develop........................................................|neogen-develop|
6.1. Developer API......................................|neogen-developer_api|
7. FAQ................................................................|neogen-faq|
================================================================================
@@ -18,33 +19,113 @@ ABSTRACT *neogen-abstrac
Neogen is an extensible and extremely configurable annotation generator for your favorite languages
Want to know what the supported languages are ?
Check out the up-to-date readme section: https://github.com/danymat/neogen#supported-languages
================================================================================
CONCEPT *neogen-concept*
TODO: update doc
* Create annotations with one keybind, and jump your cursor in the inserted annotation
* Defaults for multiple languages and annotation conventions
* Extremely customizable and extensible
* Written in lua (and uses Tree-sitter)
================================================================================
USAGE *neogen-usage*
TODO: update doc
Neogen will use tree-sitter parsing to properly generate annotations.
The basic idea is that Neogen will generate annotation to the type you're in.
For example, if you have a csharp function like (note the cursor position):
>
public class HelloWorld
{
public static void Main(string[] args)
{
# CURSOR HERE
Console.WriteLine("Hello world!");
return true;
}
public int someMethod(string str, ref int nm, void* ptr) { return 1; }
}
<
and you call `:Neogen class`, it will generate the annotation for the upper class:
>
/// <summary>
/// ...
/// </summary>
public class HelloWorld
{
<
Currently supported types are `func`, `class`, `type`, `file`.
Check out the up-to-date readme section: https://github.com/danymat/neogen#supported-languages
To know the supported types for a certain language
NOTE: calling `:Neogen` without any type is the same as `:Neogen func`
================================================================================
LUA API *neogen-lua_api*
BASIC CONFIGURATIONS *neogen-basic_configurations*
TODO: update doc
Every configuration here is to put inside your `require('neogen').setup {...}` table.
* `enabled` (defaults: `false`)
Enable Neogen.
* `input_after_comment` (defaults: `true`)
Go to annotation after insertion, and change to insert mode
================================================================================
CONFIG *neogen-config*
ADVANCED CONFIGURATIONS *neogen-advanced_configurations*
TODO: update doc
To customize a language, you can provide a custom table like this:
The defaults are provided here: https://github.com/danymat/neogen/tree/main/lua/neogen/configurations
>
require('neogen').setup {
languages = {
csharp = {
-- Configuration here
}
}
}
<
* `template.annotation_convention` (default: check the language default configurations)
Change the annotation convention to use with the language.
* `template.use_default_comment` (default: `true`)
Prepend any template line with the default comment for the filetype
* `template.append`
If you want to customize the position of the annotation
* `template.append.child_name`
What child node to use for appending the annotation
* `template.append.position` (`before/after`)
Relative positioning with `child_name`
* `template.<convention_name>` (replace `<convention_name>` with an annotation convention)
Template for an annotation convention.
To know more about how to create your own template, go here:
https://github.com/danymat/neogen/blob/main/docs/adding-languages.md#default-generator
================================================================================
DEVELOP *neogen-develop*
* Want to add a new language?
1. Using the defaults to generate a new language support:
https://github.com/danymat/neogen/blob/main/docs/adding-languages.md
2. (advanced) Only if the defaults aren't enough, please see here:
https://github.com/danymat/neogen/blob/main/docs/advanced-integration.md
* Want to contribute to an existing language?
I guess you can still read the previous links, as they have some valuable knowledge inside.
You can go and directly open/edit the configuration file relative to the language you want to contribute to.
Feel free to submit a PR, I will be happy to help you !
--------------------------------------------------------------------------------
DEVELOPER API *neogen-developer_api*
TODO: update doc
================================================================================
FAQ *neogen-faq*
TODO: update doc
Seems too calm here...