Class, method and property descriptions, and access

[gburghardt]

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:
http://javascript.crockford.com/private.html)?

Thanks.

[Tobie Langel]

On Fri, Mar 4, 2011 at 9:25 PM, gburghardt <burghar...@gmail.com> wrote:
> 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?

Yes, just use Markdown (e.g.:
https://github.com/sstephenson/prototype/blob/master/src/prototype/lang/function.js#L117-171)

> Secondly, is there a way to denote which properties and methods are
> public, privileged or private (a la Douglas Crockford:
> http://javascript.crockford.com/private.html)?

No. Why would you want to document methods which aren't meant to be
consumed externally?