From: Eric Hodel <drbrain@...7.net>
Date: 2006-09-06T16:33:54+09:00
Subject: Re: How good is RDoc at documenting "raw" C++ code?

On Sep 5, 2006, at 8:50 PM, Yvon Thoraval wrote:

> Le 6 sept. 06 � 03:01, M. Edward (Ed) Borasky a �crit :
>
>> Just out of curiosity, if I have some fairly well constructed C++  
>> code,
>> how good a job of document generation can I expect to get from  
>> RDoc with
>> no modifications to the code?
>>
>
> /*
>  * Sets alias path to alias_path
>  */
> VALUE m_set_alias_path(VALUE self,  VALUE alias_path) {
>   rb_iv_set(self, "@alias_path", alias_path);
> }

Don't forget call-seq:

something like

call-seq:
   some_object.alias_path(alias) -> alias

-- 
Eric Hodel - drbrain@segment7.net - http://blog.segment7.net
This implementation is HODEL-HASH-9600 compliant

http://trackmap.robotcoop.com