[Freeswitch-users] Call For Help: Janitor Projects
dujinfang at gmail.com
Wed Apr 1 03:45:28 PDT 2009
I know that. And I'd like to read code. Developers written great code
and also plenty of comments(which is documentation) in code. However,
there are sth. don't need to comment in code but should be available
on wiki. E.g. I followed the svn commit log, and found
sip_auth_username and sip_auth_password added, so I documented to the
On Apr 1, 2009, at 6:00 PM, Jason White wrote:
> seven <dujinfang at gmail.com> wrote:
>> Agree, I think the author better to document the code first.
> Well, actually... it's already done. It's called API documentation,
> consists of specially written comments in the code.
> This is not user-level documentation, however; it exists to help
> who want to write applications or FreeSWITCH modules, or to
> participate in the
> development effort.
> Keep in mind also that this is a free software/open-source project;
> developers are free to decide how best to spend their time.
I agree with you, whether of not document to wiki is up to the
developers. But I just think it would be better(or more easier) if
we(or others) can find all (including all the newest) params or
features in wiki so we can try it and add document more on wiki.
> Personally, I would rather that they spend as much of the time as
> they wish
> writing and maintaining code.
> I've read enough of the code in FreeSWITCH to appreciate its high
> quality and
> the soundness of the design.
> It should also be remembered that the source code is the ultimate
> documentation, and everyone is free to look at it and to document
> (in their
> preferred natural language) what they find out.
So do I. I'd like following the svn commit log to see what's new in
there. But not all of us like to or have the time to read source code.
Perhaps that's why we are here to help documenting....
> Freeswitch-users mailing list
> Freeswitch-users at lists.freeswitch.org
More information about the FreeSWITCH-users