Skip to Content.
Sympa Menu

freetds - RE: [freetds] First draft of API documentation completed

freetds AT lists.ibiblio.org

Subject: FreeTDS Development Group

List archive

Chronological Thread  
  • From: "Lowden, James K" <LowdenJK AT bernstein.com>
  • To: "'FreeTDS Development Group'" <freetds AT lists.ibiblio.org>
  • Subject: RE: [freetds] First draft of API documentation completed
  • Date: Wed, 26 Mar 2003 10:55:35 -0500

> From: ZIGLIO Frediano [mailto:Frediano.Ziglio AT vodafoneomnitel.it]
> Sent: March 26, 2003 6:12 AM
>
> > 3. Use Perl to reformat the resulting Doxygen warnings into doxygen
> > comments. Most of the warnings had to do with missing
> > parameters. It was a
> > simple thing to convert them into "\param" lines.
>
> You know... I'm not a Perl guru, you seem to be the Perl guru
> of group...

I'm JAPH. I find C++, SQL, and Perl sufficient for everything I do. One of
these days, I'm going to write isql in Perl, as a demonstration. Without
looking, I bet it's already been done.

If you like my approach, I can dig through my history file and work up a
little script to reprocess the doxygen warnings.

> I know, there isn't documentation but doxygen 1.2.14 and
> 1.2.15 seem to document it.

It must be a doxygen setting. You weren't using EXTRACT_ALL?

> Does anyone like -dj option in our .indent.pro? This strange
> option (not
> documented in my manual page) seem to have different behavior
> in different
> indent version (I noted this after your reindentation...)

It's a BSD indent switch:

-dj, -ndj -dj left justifies declarations.
-ndj indents declarations the same as code.
The default is -ndj.

It can be a bit extreme. I've noticed that sometimes we have declarations
within a loop (you couldn't do that when I was learning C) and indent makes
them left-flush, too. I think indent's logic predates variable declarations
anywhere other than at the top of a function.

My understanding of the Sense of the Senate is that -ndj variables should be
used (I hadn't noticed it in .indent.pro). I know Brian used left-flush
declarations, but others don't and it's nonstandard (or at least uncommon)
and he's not hacking the code much these days, *and* I don't think it
matters much to him. For those reasons, I've been indenting variable
declarations whenever I touch a function.

I suppose we should either adjust .indent.pro or re-reformat my
"improvements".

--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 we do not accept account orders and/or
instructions by e-mail, and therefore will not be responsible for carrying
out such orders and/or instructions.





Archive powered by MHonArc 2.6.24.

Top of Page