From: Yvon Thoraval <yvonthoraval@...>
Date: 2006-09-06T12:50:14+09:00
Subject: Re: How good is RDoc at documenting "raw" C++ code?

--Apple-Mail-30-966211912
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain;
	charset=ISO-8859-1;
	delsp=yes;
	format=flowed


Le 6 sept. 06 =E0 03:01, M. Edward (Ed) Borasky a =E9crit :

> Just out of curiosity, if I have some fairly well constructed C++ =20
> code,
> how good a job of document generation can I expect to get from RDoc =20=

> with
> no modifications to the code?
>

see <http://thoraval.yvon.free.fr/RAliasFile/> for an example (still =20
alpha), here is my C :

//
// RAliasFile.c
//
/*
* Resolve an alias file returning the path of alias target from
* alias path.
* Provides additionnal info on both the alias file itself and
* the target file/folder.
*
* Print-out version number :
*   RAliasFile.version
*
* Typical use from Ruby :
*   raf=3DRAliasFile.new("/absolute/path/to/alias/file")
*
*   raf.alias_path      # =3D> returns the given input alias path
*   raf.path_exists?    # =3D> returns true if the alias path does =20
exists on the file system, false otherwise
*   raf.is_alias_file?    # =3D> returns true if the alias is truly an =20=

alias file one, false otherwise
*   raf.is_alias_broken?  # =3D> returns true if alias is broken, false =20=

otherwise
*   raf.resolved_path    # =3D> returns the path of the alias target
*   raf.was_aliased?    # =3D> returns true if the alias is a correct =20=

alias file, false otherwise
*   raf.is_folder_alias?  # =3D> returns true if the target of the =20
alias is a folder, false otherwise
*   raf.is_file_alias?    # =3D> returns true if the target of the =20
alias is a file, false otherwise
*/

#include <CoreFoundation/CoreFoundation.h>
#include <Carbon/Carbon.h>
#include <CFURL.h>
#include <ruby.h>

VALUE cRAliasFile;

/*
* Initialize all internal variables
*/
VALUE m_raliasfile_init(int argc, VALUE* argv, VALUE self)

[...]


/*
* Sets alias path to alias_path
*/
VALUE m_set_alias_path(VALUE self,  VALUE alias_path) {
   rb_iv_set(self, "@alias_path", alias_path);
}

/*
* returns true if the path given for the alias file is on the file =20
system, false otherwise
*/
VALUE m_path_exists(VALUE self) {
   return rb_iv_get(self, "@path_exists");
}

[...]=

--Apple-Mail-30-966211912--