------=_NextPart_000_0000_01C5222F.547EF1A0
Content-Type: text/plain;
charset="us-ascii"
Content-Transfer-Encoding: 7bit

Where can I find the documentation for MySQL++? I'm using MS .NET.


------=_NextPart_000_0000_01C5222F.547EF1A0--

Joachim Person wrote:
The documentation is here: http://dev.mysql.com/doc/plusplus/en/index.html

It's sadly out of date, but even for more than 20 minor version revs,
very little in the API has really changed. If you skim the changelogs
since 1.7.9 you'll see the changes. A couple of them are noteworthy,
such as changes to filenames and a reversal of the exceptions, but most
of the changes have been bug fixes, requested additions, etc.

As a lover of documentation I'm thinking about taking this on as a
project: To get this document up to date, and to improve chapter 5,
which is the most useful but also the hardest to use.


--
MySQL++ Mailing List
For list archives: http://lists.mysql.com/plusplus
To unsubscribe: http://lists.mysql.com/plusplus?unsu...ie.nctu.edu.tw

-------------------
On Sunday 06 March 2005 17:52, Earl Miles wrote:
That's a generous offer and I'm sure would be much appreciated. I was tearing
my hair out trying to get a simple program to work, based on the manual. When
I got around to looking in the sample code I found that it was different and
some smal but crucial things have changed - eg, using
myrow.lookup_by_name("firstname").c_str()
instead of
myrow["firstname"]
as one might assume from the manual. Of course, manuals are of most value to
those, like myself, on the lower slopes of the learning curve. My C++
knowledge isn't yet good enough to derive everything simply by reading and
interpreting the sample code. Also, the manual as it nows stands is a model
of obfuscation, giving little support to those of us not fully conversant
with programming terms. For example, the early stuff about results sets left
me utterly confused, though I appreciate that English is probably not the
first language of the manual's writers. As a professional writer and editor,
I'd be happy to proofread a new version if you decide to take it on!

@+
Steve

--
MySQL++ Mailing List
For list archives: http://lists.mysql.com/plusplus
To unsubscribe: http://lists.mysql.com/plusplus?unsu...ie.nctu.edu.tw

Steve Mansfield wrote:
Actually, I think you could productively join the writing team. The
perspective of a newbie can be valuable. And, as you may have
discovered already, the best way to learn something is to try to teach
it to someone else. It uncovers all those assumptions and gray areas in
your knowledge, and you're forced to repair those holes as you go.

--
MySQL++ Mailing List
For list archives: http://lists.mysql.com/plusplus
To unsubscribe: http://lists.mysql.com/plusplus?unsu...ie.nctu.edu.tw

-------------------
On Monday 07 March 2005 19:26, Warren Young wrote:
Indeed - as I go through the manual (which, on reflection, is really, *really*
awful) I'm having a lot of those 'huh?' moments. Trouble is, at this stage I
don't know whether those are caused by my lack of knowledge about C++ or just
obscurity in the manual itself.

But for starters, there could be far more information about the underlying
natural of the various objects, data structures, methods etc. For my money,
the documentation for PHP is a model of its type (all the programming I have
done is in PHP and Perl).

So, if anyone on the writing team wants to send me the current version of the
manual, I'd be happy to go through it and mark up those points where I think
'WTF does this mean?' or 'tell me more...'.

I may be rude about the manual, but I don't expect to have everything done for
me, so I'd be happy to spend some of my time on this.

--
@+
Steve

--
MySQL++ Mailing List
For list archives: http://lists.mysql.com/plusplus
To unsubscribe: http://lists.mysql.com/plusplus?unsu...ie.nctu.edu.tw

Steve Mansfield wrote:

The problem isn't that the manual is obscure, it's that it's a reference
manual, not a tutorial. Sure, there's stuff in there that tries to be a
tutorial, but they should be separated out and clarified. We should
either have two manuals, or at least a manual in two sections. What a
newbie wants from a manual is not the same thing that those of us who
have been using MySQL++ for years want.

The tutorial should be built around the existing examples. Where
insufficient examples exist to support the flow of the tutorial, write
more examples.

I don't think anything should be done about the reference manual right
now. I'll probably initiate that effort myself, using Doxygen or
something like it:

http://sourceforge.net/projects/doxygen/

Um, so far, you and Earl are the team. Go team.

You have the current version. The last time it was touched was nearly 4
years ago, when 1.7.9 was released.

--
MySQL++ Mailing List
For list archives: http://lists.mysql.com/plusplus
To unsubscribe: http://lists.mysql.com/plusplus?unsu...ie.nctu.edu.tw

On Mon, Mar 07, 2005 at 07:40:59PM +0100, Steve Mansfield wrote:
There is no "writing team" at the moment. :-) But you can get the latest
tarball at http://tangentsoft.net/mysql++/ and the docs are in the
"doc" subdirectory.

They appear to be written in LaTeX, possibly using the LyX editor, and then
LaTeX2HTML for the web pages.

- Chris


--
MySQL++ Mailing List
For list archives: http://lists.mysql.com/plusplus
To unsubscribe: http://lists.mysql.com/plusplus?unsu...ie.nctu.edu.tw

On Mon, Mar 07, 2005 at 12:32:03PM -0700, Warren Young wrote:
Excellent idea... I was pondering suggesting this myself, but didn't want to
volunteer. :-)

In fact, some of the comments look odd, as if someone was trying to do this
all along.

If anyone is looking for a doxygen cheat-sheet, I've put mine here:
http://www.netdirect.ca/~cdfrey/tips/doxygen-sample.txt

Of course, the main doxygen website has great in-depth docs, and apparently
is completely generated by doxygen, which is a testament to its utility.


Yes, go team! :-)

- Chris


--
MySQL++ Mailing List
For list archives: http://lists.mysql.com/plusplus
To unsubscribe: http://lists.mysql.com/plusplus?unsu...ie.nctu.edu.tw

-------------------
On Monday 07 March 2005 20:32, Warren Young wrote:
True, up to a point. The two problems with the manual (from a newbie
perspective) are:

* It tries to inform by inference - in other words, it relies too heavily on
showing a code example (which, of course, now differs wildly from the
examples actually supplied) and then expecting one to devine what's going on
from that.

* It's maddeningly random and partial in what it tells you.

Okay, an example or two:

I look at the early section on Result Sets where it attempts to describe the
different types, but with no indication on how they differ in practical terms
(ie, some idea of why you'd use one rather than the other) or what form these
results sets take.

More specifically, the 'simple' example shows how to pull some rows from a
table and print them. I managed to get this working without too much trouble,
but then I look at the query object and see that it has a number of methods -
query.store(), query.preview() and I immediately want to know what other
methods there are, what types they return, what parameters, if any, they
might take. In other words, a reference list of all the methods, properties,
structures & types in the API would be very interesting. That way I can play
around with them and learn by experience.

Now, you might argue that much of this info can be gleaned by sifting through
the code, looking at function and class declarations etc. But that's the kind
of effort a manual is meant to avoid.

I find the PHP manual very useful partly because I can browse it - I've
discovered all manner of useful functions that I wouldn't have thought to
search for that way. It tells you what each function does, what params it
takes, what type it returns.

I guess what I'm saying is that I need Chapter 5! And obviously the manual
needs to be brought up to date by using the actual code from the examples.
Lots of commenting in the code might help, too.

Anyway, I'll see if I can come up with some sensible comments on the manual
as-is.

--
@+
Steve

--
MySQL++ Mailing List
For list archives: http://lists.mysql.com/plusplus
To unsubscribe: http://lists.mysql.com/plusplus?unsu...ie.nctu.edu.tw

Steve Mansfield wrote:
A pretty weak version of this exists on the web-site but not in the
distribution, as far as I can tell; And it's the start of the Doxygen
stuff that was being talked about earlier. Chapter 5 sort of exists there.



--
MySQL++ Mailing List
For list archives: http://lists.mysql.com/plusplus
To unsubscribe: http://lists.mysql.com/plusplus?unsu...ie.nctu.edu.tw