{
  "attachments": [],
  "comments_archived": true,
  "date": "2005-12-12T04:34:10.000Z",
  "layout": "post",
  "tags": [
    "asides"
  ],
  "title": "Who's using Natural Docs?",
  "wordpress_id": 794,
  "wordpress_slug": "whos-using-natural-docs",
  "wordpress_url": "http://decafbad.com/blog/?p=794",
  "year": "2005",
  "month": "12",
  "day": "11",
  "isDir": false,
  "slug": "whos-using-natural-docs",
  "type": "entry",
  "postName": "2005-12-11-whos-using-natural-docs",
  "html": "<blockquote cite=\"http://www.naturaldocs.org/\">Natural Docs is an open-source, extensible, multi-language documentation generator.  You document your code in a natural syntax that reads like plain English.  Natural Docs then scans your code and builds high-quality HTML documentation from it.</blockquote>\n\n\n<p><small style=\"text-align:right; display:block\">Source: <a href=\"http://www.naturaldocs.org/\">Natural Docs</a></small></p>\n<p>Having started using <a href=\"http://www.naturaldocs.org/\">Natural Docs</a> at work to maintain documentation on parts of a project implemented in ActionScript, JavaScript, Perl, XML, XSLT, and possibly PHP--it seems like a very cool system with an extremely simple and natural syntax applicable to a wide array of source code formats.</p>\n<p>Is anyone else out there using this package?  If you were and stopped, how come?  Just curious...</p>\n<div id=\"comments\" class=\"comments archived-comments\"><h3>Archived Comments</h3>\n<ul class=\"comments\">\n<li class=\"comment\" id=\"comment-221085393\">\n<div class=\"meta\">\n<div class=\"author\">\n<a class=\"avatar image\" rel=\"nofollow\" href=\"http://richardathome.wordpress.com\"><img src=\"http://www.gravatar.com/avatar.php?gravatar_id=fff0d05378ec238b0ccc6f5bedbf0adb&amp;size=32&amp;default=http://mediacdn.disqus.com/1320279820/images/noavatar32.png\" width=\"\" height=\"\"></a>\n<a class=\"avatar name\" rel=\"nofollow\" href=\"http://richardathome.wordpress.com\">Richard@Home</a>\n</div>\n\n\n<p><a href=\"#comment-221085393\" class=\"permalink\"><time datetime=\"2005-12-12T09:51:37\">2005-12-12T09:51:37</time></a></p>\n</div>\n\n\n<div class=\"content\"><p>Thanks for the heads up on Natural Docs, I have been using phpDocumentor but this seems to be a great way to document projects that use a variety of languages (HTML, PHP, Javascript for example).</p></div>\n\n\n</li>\n<li class=\"comment\" id=\"comment-221085394\">\n<div class=\"meta\">\n<div class=\"author\">\n<a class=\"avatar image\" rel=\"nofollow\" href=\"\"><img src=\"http://disqus.com/api/users/avatars/blalor.jpg\" width=\"\" height=\"\"></a>\n<a class=\"avatar name\" rel=\"nofollow\" href=\"\">blalor</a>\n</div>\n\n\n<p><a href=\"#comment-221085394\" class=\"permalink\"><time datetime=\"2005-12-12T11:23:46\">2005-12-12T11:23:46</time></a></p>\n</div>\n\n\n<div class=\"content\"><p>It looks like a great solution for multiple languages, but I don't see that it also supports JavaDoc.  JavaDoc has many benefits, and I would rather see Natural Docs either support JavaDoc comments, or somehow be able to include rendered JavaDoc output (or use another doclet to generate a compatible intermediary).</p></div>\n\n\n</li>\n<li class=\"comment\" id=\"comment-221085396\">\n<div class=\"meta\">\n<div class=\"author\">\n<a class=\"avatar image\" rel=\"nofollow\" href=\"http://www.decafbad.com\"><img src=\"http://www.gravatar.com/avatar.php?gravatar_id=2377f34a68801b861c3e54e1301f0dce&amp;size=32&amp;default=http://mediacdn.disqus.com/1320279820/images/noavatar32.png\" width=\"\" height=\"\"></a>\n<a class=\"avatar name\" rel=\"nofollow\" href=\"http://www.decafbad.com\">l.m.orchard</a>\n</div>\n\n\n<p><a href=\"#comment-221085396\" class=\"permalink\"><time datetime=\"2005-12-12T11:42:42\">2005-12-12T11:42:42</time></a></p>\n</div>\n\n\n<div class=\"content\"><p>Brian: Well, as I understand it, Natural Docs is a <em>replacement</em> for something like JavaDoc.  (or POD, or pydoc, or etc)  It's trying for a more wiki-like or YAML-like syntax.</p>\n<p>That's definitely a downside to Natural Docs, though, if we were using Java in our project.  We use Perl, but the ND syntax seems to complement POD a bit more than it replaces it.</p></div>\n\n\n</li>\n<li class=\"comment\" id=\"comment-221085397\">\n<div class=\"meta\">\n<div class=\"author\">\n<a class=\"avatar image\" rel=\"nofollow\" href=\"\"><img src=\"http://www.gravatar.com/avatar.php?gravatar_id=60dcf7401de8ebc16d81d206ba0eb9ce&amp;size=32&amp;default=http://mediacdn.disqus.com/1320279820/images/noavatar32.png\" width=\"\" height=\"\"></a>\n<a class=\"avatar name\" rel=\"nofollow\" href=\"\">Kodi</a>\n</div>\n\n\n<p><a href=\"#comment-221085397\" class=\"permalink\"><time datetime=\"2005-12-12T17:39:36\">2005-12-12T17:39:36</time></a></p>\n</div>\n\n\n<div class=\"content\"><p>It actually does support JavaDoc, it just hasn't been released yet.  You have to pull from CVS.  For example, see <a href=\"http://cvs.sourceforge.net/viewcvs.py/naturaldocs/NaturalDocs/Modules/NaturalDocs/Parser/JavaDoc.pm?view=markup\" rel=\"nofollow\">here</a>.</p></div>\n\n\n</li>\n</ul>\n\n\n</div>\n\n\n",
  "body": "<blockquote cite=\"http://www.naturaldocs.org/\">Natural Docs is an open-source, extensible, multi-language documentation generator.  You document your code in a natural syntax that reads like plain English.  Natural Docs then scans your code and builds high-quality HTML documentation from it.</blockquote>\r\n<small style=\"text-align:right; display:block\">Source: <a href=\"http://www.naturaldocs.org/\">Natural Docs</a></small>\r\n\r\nHaving started using [Natural Docs][nd] at work to maintain documentation on parts of a project implemented in ActionScript, JavaScript, Perl, XML, XSLT, and possibly PHP--it seems like a very cool system with an extremely simple and natural syntax applicable to a wide array of source code formats.\r\n\r\nIs anyone else out there using this package?  If you were and stopped, how come?  Just curious...\r\n\r\n[nd]: http://www.naturaldocs.org/\r\n\r\n<div id=\"comments\" class=\"comments archived-comments\">\r\n            <h3>Archived Comments</h3>\r\n            \r\n        <ul class=\"comments\">\r\n            \r\n        <li class=\"comment\" id=\"comment-221085393\">\r\n            <div class=\"meta\">\r\n                <div class=\"author\">\r\n                    <a class=\"avatar image\" rel=\"nofollow\" \r\n                       href=\"http://richardathome.wordpress.com\"><img src=\"http://www.gravatar.com/avatar.php?gravatar_id=fff0d05378ec238b0ccc6f5bedbf0adb&amp;size=32&amp;default=http://mediacdn.disqus.com/1320279820/images/noavatar32.png\"/></a>\r\n                    <a class=\"avatar name\" rel=\"nofollow\" \r\n                       href=\"http://richardathome.wordpress.com\">Richard@Home</a>\r\n                </div>\r\n                <a href=\"#comment-221085393\" class=\"permalink\"><time datetime=\"2005-12-12T09:51:37\">2005-12-12T09:51:37</time></a>\r\n            </div>\r\n            <div class=\"content\"><p>Thanks for the heads up on Natural Docs, I have been using phpDocumentor but this seems to be a great way to document projects that use a variety of languages (HTML, PHP, Javascript for example).</p></div>\r\n            \r\n        </li>\r\n    \r\n        <li class=\"comment\" id=\"comment-221085394\">\r\n            <div class=\"meta\">\r\n                <div class=\"author\">\r\n                    <a class=\"avatar image\" rel=\"nofollow\" \r\n                       href=\"\"><img src=\"http://disqus.com/api/users/avatars/blalor.jpg\"/></a>\r\n                    <a class=\"avatar name\" rel=\"nofollow\" \r\n                       href=\"\">blalor</a>\r\n                </div>\r\n                <a href=\"#comment-221085394\" class=\"permalink\"><time datetime=\"2005-12-12T11:23:46\">2005-12-12T11:23:46</time></a>\r\n            </div>\r\n            <div class=\"content\"><p>It looks like a great solution for multiple languages, but I don't see that it also supports JavaDoc.  JavaDoc has many benefits, and I would rather see Natural Docs either support JavaDoc comments, or somehow be able to include rendered JavaDoc output (or use another doclet to generate a compatible intermediary).</p></div>\r\n            \r\n        </li>\r\n    \r\n        <li class=\"comment\" id=\"comment-221085396\">\r\n            <div class=\"meta\">\r\n                <div class=\"author\">\r\n                    <a class=\"avatar image\" rel=\"nofollow\" \r\n                       href=\"http://www.decafbad.com\"><img src=\"http://www.gravatar.com/avatar.php?gravatar_id=2377f34a68801b861c3e54e1301f0dce&amp;size=32&amp;default=http://mediacdn.disqus.com/1320279820/images/noavatar32.png\"/></a>\r\n                    <a class=\"avatar name\" rel=\"nofollow\" \r\n                       href=\"http://www.decafbad.com\">l.m.orchard</a>\r\n                </div>\r\n                <a href=\"#comment-221085396\" class=\"permalink\"><time datetime=\"2005-12-12T11:42:42\">2005-12-12T11:42:42</time></a>\r\n            </div>\r\n            <div class=\"content\"><p>Brian: Well, as I understand it, Natural Docs is a <em>replacement</em> for something like JavaDoc.  (or POD, or pydoc, or etc)  It's trying for a more wiki-like or YAML-like syntax.</p>\r\n\r\n<p>That's definitely a downside to Natural Docs, though, if we were using Java in our project.  We use Perl, but the ND syntax seems to complement POD a bit more than it replaces it.</p></div>\r\n            \r\n        </li>\r\n    \r\n        <li class=\"comment\" id=\"comment-221085397\">\r\n            <div class=\"meta\">\r\n                <div class=\"author\">\r\n                    <a class=\"avatar image\" rel=\"nofollow\" \r\n                       href=\"\"><img src=\"http://www.gravatar.com/avatar.php?gravatar_id=60dcf7401de8ebc16d81d206ba0eb9ce&amp;size=32&amp;default=http://mediacdn.disqus.com/1320279820/images/noavatar32.png\"/></a>\r\n                    <a class=\"avatar name\" rel=\"nofollow\" \r\n                       href=\"\">Kodi</a>\r\n                </div>\r\n                <a href=\"#comment-221085397\" class=\"permalink\"><time datetime=\"2005-12-12T17:39:36\">2005-12-12T17:39:36</time></a>\r\n            </div>\r\n            <div class=\"content\"><p>It actually does support JavaDoc, it just hasn't been released yet.  You have to pull from CVS.  For example, see <a href=\"http://cvs.sourceforge.net/viewcvs.py/naturaldocs/NaturalDocs/Modules/NaturalDocs/Parser/JavaDoc.pm?view=markup\" rel=\"nofollow\">here</a>.</p></div>\r\n            \r\n        </li>\r\n    \r\n        </ul>\r\n    \r\n        </div>\r\n    ",
  "parentPath": "./content/posts/archives/2005",
  "path": "2005/12/11/whos-using-natural-docs",
  "needsBuild": true,
  "prevPostPath": "2005/12/09/delicious-and-yahoo-sitting-in-a-tree",
  "prevPostTitle": "del.icio.us and Yahoo! sitting in a tree",
  "nextPostPath": "2005/12/13/feedmagick-the-show-me-dont-tell-me-edition",
  "nextPostTitle": "FeedMagick, the show-me-don't-tell-me edition"
}