API index idea

View: New views
2 Messages — Rating Filter:   Alert me  

API index idea

by Jonathan Vanasco-5 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


What do people think of an API function index?

it would be listed off
        http://perl.apache.org/docs/2.0/api/index.html

and just have a listing of every API class , and the names of the  
class methods -- with hotlinks to the class data.

this way people can just find the right class by the method name  
(which i tend to need more often than i'd like)


// Jonathan Vanasco

| - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  
- - - - - - - - - - - - - - - -
| FindMeOn.com - The cure for Multiple Web Personality Disorder
| Web Identity Management and 3D Social Networking
| - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  
- - - - - - - - - - - - - - - -
| RoadSound.com - Tools For Bands, Stuff For Fans
| Collaborative Online Management And Syndication Tools
| - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  
- - - - - - - - - - - - - - - -



---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@...
For additional commands, e-mail: docs-dev-help@...


Re: API index idea

by Perrin Harkins :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Jonathan Vanasco wrote:
> this way people can just find the right class by the method name (which
> i tend to need more often than i'd like)

You can use ModPerl::MethodLookup for that:
http://perl.apache.org/docs/2.0/api/ModPerl/MethodLookup.html

   perl -MModPerl::MethodLookup -e print_method some_method_name

A web index would be fine too, but it would be nice if it could be
auto-generated to reduce maintenance.

- Perrin

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@...
For additional commands, e-mail: docs-dev-help@...

LightInTheBox - Buy quality products at wholesale price!