Re: PDoc and custom events

[Tobie Langel]

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
* event ajax:request:completed
* - data (Ajax.Response) the response object itself
* Fired when... etc
**/

That's not implemented yet afaik.

That should give you both the searchability and linkability you wanted.

Best,

Tobie

On Fri, Oct 9, 2009 at 4:46 PM, Thomas Fuchs <...> wrote:
> Hey Tobie,
>
> I'm looking for a way to use PDoc to document custom events fired by
> some extensions for scripty2 I'm working on.
>
> Do you have an idea how to handle this best? Right now, I'm just
> stuffing the documentation into the namespace description, but it's
> not searchable or linkable this way-- I want the custom events to show
> up as their own thing in the search box.
>
> Best,
> Thomas
>