https://github.com/akirak/docco.el

(WIP) A structural editing package for documentation comments and annotations
https://github.com/akirak/docco.el

Last synced: 7 days ago
JSON representation

(WIP) A structural editing package for documentation comments and annotations

• Host: GitHub
• URL: https://github.com/akirak/docco.el
• Owner: akirak
• Created: 2024-06-07T13:26:53.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-10-28T16:16:03.000Z (10 days ago)
• Last Synced: 2024-10-28T17:39:54.614Z (10 days ago)
• Language: Emacs Lisp
• Homepage:
• Size: 36.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org

Awesome Lists containing this project

README

        
* Docco.el

Docco.el is a framework for editing documentation comments inside source code.

It aims to be generic enough to support various programming languages and is desiged to be extensible.

It relies on the built-in tree-sitter support of Emacs (i.e. ~treesit~) to define structural patterns easily.

For major modes that are not based on ~treesit~ or have only a poorly-defined parser, regular expressions are used to define patterns.

** Supported Languages

- ~rust-ts-mode~ (Rust)

- ~gleam-ts-mode~ (Gleam)

- ~elixir-ts-mode~ (Elixir)

** Usage

- ~docco-edit-module-comment~ for editing a documentation comment of the current module

- ~docco-edit-function-comment~ for editing a documentation comment of the function at point

** See Also

- [[https://github.com/akirak/cosmetic-transient.el][cosmetic-transient]] is a frontend that supports this project.