Project Summary
PDoc is an inline comment parser and JavaScript documentation generator written in Ruby. It is designed for documenting Prototype and Prototype-based libraries.
PDoc uses Treetop, a Ruby-based DSL for text parsing and interpretation, and its own ActionView-inspired, ERB-based templating system for HTML generation. Other documentation generators (e.g., DocBook XML) are planned.
Unlike other inline-doc parsers, PDoc does not rely on the JavaScript source code at all; it only parses the comments. This approach, though slightly more verbose, is much better at generating consistent, reliable documentation, and avoids the headaches encountered when documenting highly dynamic languages.
In a Nutshell, PDoc.org...
- ...
- ...
- ...
-
...
took an estimated 5 years of effort (COCOMO model)
starting with its first commit in April, 2008
ending with its most recent commit almost 12 years ago
Quick Reference
MIT License
Permitted
Commercial Use
Modify
Distribute
Sub-License
Private Use
Forbidden
Hold Liable
Required
Include Copyright
Include License
These details are provided for information only. No information here is legal advice and should not be used as such.
Project Security
Vulnerabilities per Version ( last 10 releases )
There are no reported vulnerabilities
Project Vulnerability Report
Security Confidence Index
Vulnerability Exposure Index
Did You Know...
-
...
in 2016, 47% of companies did not have formal process in place to track OS code
-
...
compare projects before you chose one to use
-
...
there are over 3,000 projects on the Open Hub with security vulnerabilities reported against them
-
...
you can subscribe to e-mail newsletters to receive update from the Open Hub blog
30 Day SummaryFeb 10 2026 — Mar 12 2026
|
12 Month SummaryMar 12 2025 — Mar 12 2026
|
