PDoc Google Group

Problems installing Prototype docs

2012-01-08T12:15:33Z

CONTENTS
=========

1. the long version
2. the short version
3. last but not least

1. THE LONG VERSION
===================

after installing the newest ruby i did:

--- snip ---
C:\>gem install rake maruku treetop
Successfully installed rake-0.9.2.2
Fetching: syntax-1.0.0.gem (100%)

src_code_href wrong number of arguments (1 for 2)

2011-04-18T17:10:31Z

I'm having trouble getting started with PDoc and am new to ruby/rake.
I'm using Ubuntu 10.10, clone the repository from git, and installed
everything from scratch.

I'm just trying to get the test working at the moment using Ajax.js
but keep getting this "wrong number of arguments" error.

Any help would be much appreciated.

Class, method and property descriptions, and access

2011-03-04T20:25:05Z

Hi, I just started using PDoc. I've perused the docs on pdoc.org, but
I'm wondering if there is a way to include descriptions of classes,
methods and properties beyond just describing arguments and data
types?

Secondly, is there a way to denote which properties and methods are
public, privileged or private (a la Douglas Crockford:

feature request - single page doc

2010-10-31T17:04:34Z

Hi,

I would like to request a feature that changes pdoc output from
multiple webpages (one for object, class, method, etc.) into a single
page, where whole HTML documentation is put into a JSON
Then, after clicking on navigation on the right, Javascript gets
requested page from JSON and displays it in right frame.

"rake doc" failure using latest

2010-02-19T19:40:32Z

I've downloaded the latest prototype and pdoc from github, and cannot
build the documentation. I first tried to build docs on a test project
and got a similar failure (specifically "wrong number of arguments (1
for 2)" with the same stack trace ). Is this is a known issue? Quite
interested in using this for ActiveJS. Switched to sprockets yesterday

Section children

2010-01-07T20:03:38Z

Hi all,
There's an ongoing issue with section children that I'm partly fixing right
now (commits will be on Github shortly). Basically, since you can label any
namespace as belonging to any section, there is not a strict hierarchical
relationship between sections and namespaces. e.g. in JS.Class the 'JS' and

BlueCloth on Windows works now (theoretically)

2010-01-03T00:18:15Z

I just got notified of activity on this bug [1] I'd filed a couple
months ago. It references this thread [2], which indicates that
installing BlueCloth thusly...
gem install bluecloth --platform=ruby
... is a workaround, and suggests that the problem will be fixed once
and for all with the next release. I haven't actually tried this yet,

bin/pdoc not working on commit e4290279a1d42bc02b09b234291a2d05c0134a43?

2009-12-25T21:43:03Z

Hello, the (as of today) newest commit into pdoc
(e4290279a1d42bc02b09b234291a2 d05c0134a43) doesn't seem to execute
properly for me.
I'm running:
./bin/pdoc -o outDir test/fixtures/ajax.js
from the root of the repo. It completes the parsing phase, but then I
get this:
Parsing source files: test/fixtures/ajax.js.

Help building the basic template files into docs...

2009-12-17T20:23:24Z

Hello, and firstly, thanks for the work put into PDoc. It gets me
really motivated to get good inline docs in my JS files on my newest
library.
I'm having a very basic problem though, as I can't even seem to build
the basic example files in repository. After a fresh checkout, I just
run "rake doc" in the root folder, and things start processing. I get

Syntax highlight support

2009-10-21T19:32:26Z

Hi folks,
I've just pushed syntax highlight support to a new branch.
It works on Prototype documentation, but you should try it on your own
projects before we merge it into master.
You just have to add the `:syntax_highlighter` option to the
`PDoc::Runner` constructor, available options are `:none`, `:coderay`,

Re: PDoc and custom events

2009-10-09T22:21:33Z

For events, I had the following in mind:
1) a hook inside documentation of methods / constructors with which
fired events can be specified. I think that's already implemented.
2) the possibility of documenting events just like methods are
documented, with the following kind of syntax:
/** belongs to: Ajax.Request, section: ajax

running pdoc on multiple libraries concatenated together

2009-10-09T01:58:45Z

I've started writing a library called klass.js and it uses pdoc for
documentation. Today I tried running pdoc on prototype and klass.js
concatenated together and pdoc barfed. It seems you cannot define a
section with the same name twice.

Both prototype and my klass.js have a Language section. I.E we both

Maruku issues

2009-09-02T23:06:44Z

Bumped into the following issue with Maruku: lines starting with an
inline HTML element are mistakenly treated as HMTL blocks.

For example:

Maruku.new("<span>foo</span> foo").to_html

Throws:

______________________________ ______________________________ _______________
| Maruku tells you:

Sub-sections

2009-08-24T22:01:08Z

Hello.

I'm in the thick of commenting my code PDoc-style and wondered if it's
possible to create sub-sections, or have namespaces display their
classes?

Currently I have a structure in my code which looks something like
this...

var myObj = {};
myObj.mySection = {}; // This is what I'm using as my 'section'

Code highlighting

2009-08-12T01:08:10Z

Hi,

A recent change in master (using rdiscount instead of bluecloth for
markdown parsing) removed the ability to highlight code examples on
the client side.

I know there were numerous suggestions to handle that in ruby, can
anybody please look into it?

Thanks,

Tobie

Notification of upcoming changes

2009-08-08T22:30:21Z

Hi all,
I started working on PDoc--at long last--during the first Prototype
Hackfest, held last mid-July in Vienna.
On this occasion, I forked Tobie's master on GitHub and implemented the
following changes, which are scheduled now for inclusion back in the ref
master (therefore, you should be aware of them in advance):

Terminal escape sequences

2009-08-06T08:56:49Z

Hi all,
Looking through the PDoc source to see how it renders the build progress
meter, I see:
log "\c[[F\c[[K Rendering: #{dest}"
Is there a good reference for these escape sequences anywhere? They're not
terribly Google-friendly.

Hi everyone how are you?

2009-07-19T07:56:28Z

I am new to this group so any feedback on how to use this will be
great.

Carolann Beardmore

Using CodeRay to replace JS-based syntax highlighting

2009-06-11T16:11:44Z

Hi all,

JavaScript-based syntax highlighting sucks, and we all know it. Here's
a little snippet to use coderay instead, make sure you do 'sudo gem
install coderay' first.

This probably has some bugs, and obviously needs some styling love,
but it's a much better solution, and fiddling with brittle JS-based

Collaboration

2009-05-28T11:51:32Z

Hi everybody,

There's quite a bunch of us with commit rights now collaborating on
this project.

It would be very helpful if we all liaised on this mailing list just
to make sure we don't step on each other's toes.

I've added a commit hook to pdoc's twitter account, so keeping up to
date on changes should be as easy as following @pdoc.

Object nesting in class menu

2009-03-17T14:26:17Z

So I just committed some code to make the Website generator generate
pages for all declared classes, even if their parent objects are
missing e.g. this:

/** section: ajax
* class Ajax.Some.RandomClass
**/

Will generate a documentation page at ajax/ajax/some/randomclass.htm l,
even if Ajax and Ajax.Some are not documented anywhere.

PDoc templates for prototypejs.org?

2009-02-27T09:58:52Z

Hi all

I really like the way the official Prototype API pages are rendered,
so I was wondering if someone had created PDoc templates to generate
something similar?

--
Regards,

Chriztian Steinmeier
[link]

Documenting MyClass#initialize

2009-02-07T00:29:18Z

What is the correct format for documenting the "initialize" method for
classes?

Is it this?

/**
* MyClass#initialize(arg1, arg2, arg3)
* - arg1 (Integer): blah blah blah
* - arg2 (String): blah blah blah
* - arg3 (Boolean): blah blah blah
**/

I mostly ask because #initialize is sort of like a constructor, but

pdoc @ mapeed.com

2009-01-07T13:21:35Z

First know live use of pdoc over at [link]

Hope there will be many more to come!

Using `this` as a return value.

2008-12-14T16:21:25Z

What do you guys think of using `this` as return value for methods
which actually returns their receiver.
It could avoid confusion with methods returning an instance of the
same class.
i.e. `Array#clear() -> this` vs. `Array#without(value...) -> Array`

Integrating PDoc in Prototype

2008-12-14T05:36:20Z

Hello everyone,

I've been working on porting Prototype online documentation to PDoc
inline comments.
Current work in progress is visible on my GitHub fork [1], it is based
on "rewrite" branch which has been merged in "master" a few days ago.
All "lang" methods are declared there, Some of them contain both

Optimizing PDoc

2008-11-24T07:06:30Z

I've been working on ways to speed up PDoc and/or decrease its memory
usage.

Parsing is a bit slow, but not all that bad. The prototype.js test
fixture parses in about 60 seconds.

(Tobie, is there any way we can show a progress indicator during the
parsing stage? Is the parser aware of its "position" in the file and/

Inheritance data

2008-11-18T15:02:27Z

Hi list,

I’m doing some stuff related to inheritance information on this
branch:

[link]

Not sure I’m calling it ‘finished’ at any point, but feel free to pull
what you like. I’m trying to figure out how much inheritance
information to assume, given that much of the inheritance semantics is

Running PDoc...

2008-10-30T16:55:15Z

Hi,

Been using Proto/Scripty and have been looking for a good doc tool...
was about to us jsdoc, when I discovered PDoc... which seems to fit
better with these libraries... Downloaded it from github... but there
is no running instructions / ruby compatibility requirements, etc. How
about a few simple getting starting examples?

Logo / Website (?) design

2008-04-15T00:02:29Z

Hi,

I'm looking for a talented designer who would be willing to contribute
a logo design for PDoc, and eventually, design the website for it too
(just to clarify: it's pro bono work).

Please get in touch with me if you're interested.

Thanks,

Tobie

Expand config/options object

2008-04-14T17:48:30Z

One thing I see a lot of in projects built on top of Prototype is the
use of a config or options object, a good example of this is the
Scriptaculous Effects, these take an id and an options object as
arguments.

The PDoc documentation suggests that this could be documented like
this...

/**