Skip to Content.
Sympa Menu

freetds - RE: Doxygen LibTDS API Reference

freetds AT lists.ibiblio.org

Subject: FreeTDS Development Group

List archive

Chronological Thread  
  • From: "Lowden, James K" <LowdenJK AT bernstein.com>
  • To: "'TDS Development Group'" <freetds AT franklin.metalab.unc.edu>
  • Subject: RE: Doxygen LibTDS API Reference
  • Date: Fri, 13 Sep 2002 11:38:07 -0400


> From: Brian Bruns [mailto:camber AT ais.org]
> Sent: September 13, 2002 8:18 AM
>
> The document is generated off of JavaDoc style comments
> within the code,
> so helpfully this will be a boon to both developers and those
> interested in using libtds.

Agreed. I am also helpfully that this will hope the developers.

> Let me know what you think before I go too far down this path.

I have in mind precisely this style and technology for the client libraries.
I've mentioned it before, and it's never generated much excitement (or even
comment), so I have a hard time getting charged up about it. But I have
this idea that a library should document its functions, even if the
functions were defined by someone else. Otherwise, it's like getting a C
compiler that comes with the advice, "find some documentation for fopen()
and stuff. What it says is what we do."

Please incorporate the doxygen stuff into the Makefile.am as a "run it if
installed" target. One lesson from the 0.60 release is to deal with
makefile issues, um, early and and often.

I got a response to a months-old request for support from the LXR folks on
sf. I'm going to give that another go on the FreeTDS tree.

Regards,

--jkl


The information contained in this transmission may contain privileged and
confidential information and is intended only for the use of the person(s)
named above. If you are not the intended recipient, or an employee or agent
responsible for delivering this message to the intended recipient, any
review, dissemination, distribution or duplication of this communication is
strictly prohibited. If you are not the intended recipient, please contact
the sender immediately by reply e-mail and destroy all copies of the
original message. Please note that for certain accounts we do not accept
orders and/or instructions by e-mail, and for those accounts we will not be
responsible for carrying out such orders and/or instructions. Kindly refrain
from sending orders or instructions by e-mail unless you have confirmed that
we accept such communications for your account. Please also note that to
satisfy regulatory requirements we review the outgoing and incoming e-mail
correspondence of staff members serving certain functions.






Archive powered by MHonArc 2.6.24.

Top of Page