docscribe.nvim

docscribe.nvim is a Neovim plugin designed to streamline the generation of inline documentation for functions by leveraging Language Models (LLMs). This tool enables developers to produce high-quality, contextually aware documentation effortlessly.

Key Features

• Automatic Documentation Generation
  Generate and insert function documentation in a language-specific format with a single command.
• LLM Integration
  Utilizes Ollama to provide intelligent and contextual documentation.
• Multi-Language Support
  Features dedicated prompt templates optimized for various programming languages, including JavaScript, TypeScript, C, Java, C++, and Python.
• Real-Time Feedback
  Provides visual feedback, including a spinner and function highlighting, during the documentation process.
• Docstring Management
  Automatically detects and removes existing docstrings before inserting new ones, making the documentation process seamless.

Supported Languages

Supported LLM Providers

Usage Instructions

To use docscribe.nvim, place the cursor inside or on a function and execute the command:

:DocscribeGenerate

The plugin will then detect the function, remove any existing documentation, and generate a new, appropriately formatted docstring.

Configuration Options

Customize the plugin behavior with various configuration options, including LLM settings and custom prompt templates for documentation formatting. Templates must include placeholders for function code, ensuring they are replaced correctly during generation.

Future Development

Exciting features are planned for subsequent releases, including support for additional programming languages, integration with more LLM providers (such as OpenAI and Anthropic), customizable documentation styles, and batch documentation generation capabilities.

docscribe.nvim simplifies the documentation process in Neovim, making it easier to create clear and effective function documentation with the power of LLMs.