codoc 0.1.0

Unified documentation parser for Ruby and TypeScript codebases
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.1.0] - 2025-12-16

### Added

- Initial release of codoc
- Ruby parser with Yardoc comment support
  - Classes, modules, methods, properties, constants
  - `attr_reader`, `attr_writer`, `attr_accessor` detection
  - `include`, `extend`, `prepend` support
  - Visibility tracking (public, protected, private)
- TypeScript parser with JSDoc/TypeDoc comment support
  - Classes, interfaces, type aliases, enums
  - Method overloads
  - Getter/setter accessors
  - Generic type parameters with constraints
- Documentation tag support
  - `@param`, `@option`, `@return`/`@returns`
  - `@raise`/`@throws`, `@yield`, `@yieldparam`, `@yieldreturn`
  - `@example`, `@see`, `@note`, `@todo`
  - `@deprecated`, `@since`, `@author`
  - `@private`/`@internal`, `@template`
- Unified JSON output format
  - Flat entity structure with `kind` discriminator
  - Symbol table for cross-referencing
  - External link mapping support
- CLI with colored output and parsing statistics
- Library API for programmatic usage

[Unreleased]: https://github.com/sudoremo/codoc/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/sudoremo/codoc/releases/tag/v0.1.0