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

//! Codoc - Unified code documentation parser for Ruby and TypeScript.
//!
//! This library provides parsers for extracting documentation from Ruby
//! (Yardoc-compatible) and TypeScript (TypeDoc-compatible) source code,
//! outputting a unified JSON format.
//!
//! # Example
//!
//! ```no_run
//! use codoc::{RubyParser, Parser, ParserConfig, ParseContext, Language};
//! use std::path::Path;
//!
//! let mut parser = RubyParser::new().expect("Failed to create parser");
//! let config = ParserConfig::new("MyProject", Language::Ruby);
//! let mut ctx = ParseContext::new(config);
//!
//! let content = std::fs::read_to_string("lib/my_class.rb").unwrap();
//! let entities = parser.parse_file(Path::new("lib/my_class.rb"), &content).unwrap();
//! ctx.entities.extend(entities);
//!
//! let document = ctx.into_document();
//! ```

pub mod error;
pub mod parser;
pub mod schema;

/// Schema version identifier used in generated documents.
pub const SCHEMA_VERSION: &str = "codoc/v1";

pub use error::{Error, Result};
pub use parser::ruby::RubyParser;
pub use parser::typescript::TypeScriptParser;
pub use parser::{ParseContext, Parser, ParserConfig};
pub use schema::{Document, Entity, Language, Metadata};