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 over 11 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...
-
...
use of OSS increased in 65% of companies in 2016
-
...
learn about Open Hub updates and features on the Open Hub blog
-
...
nearly 1 in 3 companies have no process for identifying, tracking, or remediating known open source vulnerabilities
-
...
by exploring contributors within projects, you can view details on every commit they have made to that project
30 Day SummarySep 1 2025 — Oct 1 2025
|
12 Month SummaryOct 1 2024 — Oct 1 2025
|
