[Solar-talk] Solar docs

[Paul M Jones]

On Oct 4, 2006, at 1:12 PM, Rodrigo Moraes wrote:

> On 10/4/06, Paul M Jones wrote:
>>> I would say
>>> the same for the docs generator, sorry, but, again, I would only
>>> encourage this decision if someone is not too involved or "in  
>>> love" to
>>> discontinue these tools in benefit of the framework core. :-|
>>
>> Also sounds OK to me, if we can get a PhpDocumentor guru to make it
>> generate one file per method so I can have them individually
>> addressable on the website.
>
> May I ask why?

Main reason is that I want to be able to point users to individual  
methods, much like the PHP documentation, and that the addressing  
syntax look like the method name itself.  E.g., Class::method() or  
Class::$property versus Class#method() and Class#$property.


> I think that browsing the classes is harder when each
> method has its own page. I experienced this when I was starting with
> Solar. I usually had a lot of browser tabs opened to acess the API
> docs for a single class...

You make a very good point here.  Can you think of a system or setup  
that would allow both?  Also, each documentation area has a  
ClassMethods page that lists all the methods (also a ClassProperties  
page).  E.g.:

* <http://solarphp.com/index.php/docs/read/Solar/ClassMethods>

* <http://solarphp.com/index.php/docs/read/Solar/ClassProperties>


> Anyway, I think PhpDocumentor can do this, yes. I'll try.

Thanks, I am eager to see what results you come up with.  Personally,  
I found it difficult to comprehend how to do that with PhpDocumentor  
(for all of its other strengths).



--

Paul M. Jones  <http://paul-m-jones.com>

Solar: Simple Object Library and Application Repository
for PHP5.   <http://solarphp.com>

Savant: The simple, elegant, and powerful solution for
templates in PHP.   <http://phpsavant.com>