On Sun, 25 Apr 2010, Joseph Montanez wrote:
Okay,
Since there hasn't been a clear response on this I've started my own
website, to start documenting more of the use of each library. However
doing so I am finding some clear issues, and that is some of these
units are not finished all the way.
David Emerson schrieb:
> I'm far more comfortable using git than svn, and if there was such a repo it
> would help lower the barrier to entry for me at least.
I created a mercurial mirror: http://florianklaempfl.de:8000/fpcdocs/
___
fpc-pascal maillis
On 27 April 2010 04:39, Joseph Montanez wrote:
>
> Spent another hour making a pretty example, found out there was no CSS
> file generated, and made my own:
> http://www.gorilla3d.com/fpdoc/animal/tanimal.talk.html
Nice. I reported the missing CSS file issue years ago. I thought it
was fixed - I
On 27 April 2010 02:00, John wrote:
>>
> I think you missed my point. I don't need 'new developer' documentation for
> OOP. What I can't understand is how the documentation system itself works,
> ie, how to go about using it to contribute documentation.
* Download 'fpdoc.pdf' or 'fpdoc.ps' and
In our previous episode, Joseph Montanez said:
> I just spent 2 hours on FPDoc's trying to get how to use it. Automatic
> documentation was dead easy but the whole XML integration part was a
> nightmare, so I gave up reading the docs on how to use the doc.
> Instead I figure "Hey there must be exam
I just spent 2 hours on FPDoc's trying to get how to use it. Automatic
documentation was dead easy but the whole XML integration part was a
nightmare, so I gave up reading the docs on how to use the doc.
Instead I figure "Hey there must be examples of this right?" ... *digs
through source* ... 5 mi
On 26/04/2010 11:52 PM, Graeme Geldenhuys wrote:
...
John het geskryf:
On the other hand, Joseph has a point -
I have worked out most bits of FPC over the course of a few years, but
Granted that the bulk of FPC's documentation is simply Class or API
documentation. A more "new developer" fri
On 27 April 2010 00:51, David Emerson wrote:
>
> I'm far more comfortable using git than svn
Me too, and it didn't take long either.
> Graeme, I have to ask... on the one hand, you noted that having fragmented
> documentations over various locations is unhelpful; and on the other hand,
> I've
>
On Mon 26 Apr 2010, Graeme Geldenhuys wrote:
> Florian Klaempfl het geskryf:
> >
> > No git mirror ;)? I think the docs are one of the fpc related
> > repositories where using a dvcs might be useful.
>
> Apparently I am banned for life mentioning the "product that may not be
> named" in FPC or L
Florian Klaempfl het geskryf:
>
> No git mirror ;)? I think the docs are one of the fpc related
> repositories where using a dvcs might be useful.
Apparently I am banned for life mentioning the "product that may not be
named" in FPC or Lazarus mailing lists. :-)
As for moving to such a DVCS...
John het geskryf:
>
> On the one hand, Graeme is probably right, in that putting it in the
> docs is the *best* thing to do.
Definately!
> On the other hand, Joseph has a point -
> I have worked out most bits of FPC over the course of a few years, but
Granted that the bulk of FPC's docu
Joseph Montanez het geskryf:
>
> The language itself is even worst, this is the biggest pitfall of
> Pascal in general. I can't tell you how hard it is to find anything on
> google, and I do mean anything.
Free Pascal is based on Delphi's Object Pascal language. There are lots of
documentation fo
> But does this mean you have decided to pursue GIT if there is a DVCS to be
> used at all?
No. Git was just an example.
___
fpc-pascal maillist - fpc-pascal@lists.freepascal.org
http://lists.freepascal.org/mailman/listinfo/fpc-pascal
In our previous episode, Florian Klaempfl said:
> > I would suggest you checkout the latest copy of the documentation
> > SubVersion repository:
> >
> >http://svn.freepascal.org/svn/fpcdocs/trunk
>
> No git mirror ;)? I think the docs are one of the fpc related
> repositories where using a d
I would suggest you checkout the latest copy of the documentation
SubVersion repository:
http://svn.freepascal.org/svn/fpcdocs/trunk
No git mirror ;)? I think the docs are one of the fpc related
repositories where using a dvcs might be useful. The entry barrier to
make changes is a lot low
On 26/04/2010 8:23 AM, Joseph Montanez wrote:
I would suggest you checkout the latest copy of the documentation
SubVersion repository:
http://svn.freepascal.org/svn/fpcdocs/trunk
Then submit code examples for the various units.
Are you seriously want everyone that wants to help out b
> I don't see a benefit in having fragmented documentation over various
> websites and locations. This makes it near impossible for a end-user to find
> help.
The language itself is even worst, this is the biggest pitfall of
Pascal in general. I can't tell you how hard it is to find anything on
On 25 April 2010 21:48, Joseph Montanez wrote:
> Since there hasn't been a clear response on this I've started my own
> website, to start documenting more of the use of each library.
The class documentation generated by fpdoc has support for examples.
FPC's policy is to only publish documentation
Okay,
Since there hasn't been a clear response on this I've started my own
website, to start documenting more of the use of each library. However
doing so I am finding some clear issues, and that is some of these
units are not finished all the way. Is there some list of missing
functionality somew
Joseph, Vincent,
<+1>
Add me to the list here.
I also offer to help, especially for writing UML diagrams to help people
visualize, including use cases, class diagrams and scenarios. Every
component I publish has unit testing and UML diagrams, if only a few.
Thierry
_
Vincent,
Never even knew that existed. It is a big problem with just slapping
commenting ability to docs. If its not being used its because there
isn't incentive for it. When you see the entire documentation blank of
comments would you be so inclined to add it? Documentation is so
important and as
Joseph Montanez schreef:
In the end I think automated documentation is bad, and thats really
what I see with the current state of FPC docs. It might allow better
ability to stay sync with the current release but not allowing _easy_
social interaction to expand those docs, I think it is a big mi
22 matches
Mail list logo
