Re: Could this be done on every ISO/IEC 14882:2003 implementation?

From: Steven T. Hatton (susudata_at_setidava.kushan.aa)
Date: 06/04/04 

Date: Fri, 04 Jun 2004 14:02:07 -0400

David Harmon wrote:

> On Fri, 04 Jun 2004 12:41:08 -0400 in comp.lang.c++, Pete Becker
> <petebecker@acm.org> wrote,
>>Victor Bazarov wrote:
>>>
>>> Steven T. Hatton wrote:
>>> > This was written for the gnu.g++.help list. It rather clearly spells
>>> > out [..]
>>>
>>> I must be riding my stupid horse today.
>>
>>Nope. I couldn't figure it out, either. A sentence or two describing
>>what's desired would be helpful.
>
> He wants to generate library user documentation from the object code.

Actually, that's not quite what I want, but close. First off, if I just had
the freakin' headers formatted to reflect the interface (what a concept),
that would be a huge part of the battle. The following is quite common in
C++ headers. It is the <vector> header from gnu. Yes, in this rare
instance I am saying nasty things about gnu.

/** @file vector
 * This is a Standard C++ Library header. You should @c #include this
header
 * in your programs, rather than any of the "st[dl]_*.h" implementation
files.
 */

#ifndef _CPP_VECTOR
#define _CPP_VECTOR 1

#pragma GCC system_header

#include <bits/functexcept.h>
#include <bits/stl_algobase.h>
#include <bits/stl_alloc.h>
#include <bits/stl_construct.h>
#include <bits/stl_uninitialized.h>
#include <bits/stl_vector.h>
#include <bits/stl_bvector.h>

#ifdef _GLIBCPP_NO_TEMPLATE_EXPORT
# include <bits/vector.tcc>
#endif

#endif /* _CPP_VECTOR */

There is a tool, freely available, which creates very nice C++ api
documentation. http://www.doxygen.org

In a typical Java IDE it is very easy to add libraries, and to have the IDE
query them to find all the symbols available, or potentially available to
the current scope. This means the IDE can do a great deal of the drudge
work of locating symbols within the available libraries, and providing the
necessary code in order to use the symbol. It also makes it possible for
the IDE to verify the code contains valid identifiers, and can mark invalid
code wish some kind of error indicator. The power of such tools is hard to
fully communicate without the audience having experience using them. 

-- 
STH 
Hatton's Law: "There is only One inviolable Law"
KDevelop: http://www.kdevelop.org  SuSE: http://www.suse.com
Mozilla: http://www.mozilla.org

Relevant Pages

  • Re: to learn jQuery if already using prototype
    ... the navigator.userAgent string is a reflection of the HTTP User Agent ... header then any such direction must lead to the definition of the header ... browsers using the UA string whenever two different browsers use UA ... things that gets proposed as a justification for libraries of this sort ...
    (comp.lang.javascript)
  • Re: About libraries and headers
    ... You are assuming that the contents of a header file are closely ... The standard header files ... which are used to build the libraries. ... compiling them would not generate any ...
    (comp.lang.c)
  • Re: bool & stdbool.h
    ... libraries. ... "library", it is a header. ... Dinkumware http://dinkumware.com/manuals/reader.aspx?lib=cpp which lists the ... Standard C library. ...
    (comp.lang.c.moderated)
  • Re: Thoughts on file organisation
    ... on stdlib.h for its declarations, ... recommend not to use header guards. ... functions, one for I/O, and none for system calls. ... the files in /sys/include correspond to libraries. ...
    (comp.lang.c)
  • Re: Ann: Luxasm 00.01.00 (2004-04-08)
    ... >> itself before the IDE is handled, ideally by someone else as I am ... > The only thing I've got against Motif is I don't know anything about it. ... (You will need the GNU lesstif libraries to run them.) ... due to the way the LGPL works, ...
    (alt.lang.asm)