Re: [Rcpp-devel] Rcpp API Reference

2014-09-05 Thread Tim Keitt
t > > Financial & Risk Management Solutions > > Fiserv > > Office: 678-375-5315 > > www.fiserv.com > > > > *From:* Yixuan Qiu [mailto:yixuan@cos.name] > *Sent:* Thursday, September 04, 2014 10:17 PM > *To:* Smith, Dale (Norcross) > *Cc:* rcpp-deve

Re: [Rcpp-devel] Rcpp API Reference

2014-09-05 Thread Smith, Dale (Norcross)
Analyst Financial & Risk Management Solutions Fiserv Office: 678-375-5315 www.fiserv.com<http://www.fiserv.com/> From: Yixuan Qiu [mailto:yixuan@cos.name] Sent: Thursday, September 04, 2014 10:17 PM To: Smith, Dale (Norcross) Cc: rcpp-devel@lists.r-forge.r-project.org Subject: Re: [Rcpp-d

Re: [Rcpp-devel] Rcpp API Reference

2014-09-04 Thread Yixuan Qiu
Hi all, I do appreciate your kind suggestions, and will definitely take Doxygen into account. The reason why I'm not using it at the moment is that I could be freer to organize the structure of a manually edited document, and that's why I titled this project as "Rcpp Notes". It's a kind of draft at

Re: [Rcpp-devel] Rcpp API Reference

2014-09-04 Thread Gabor Grothendieck
On Wed, Sep 3, 2014 at 11:03 PM, Yixuan Qiu wrote: > Dear all, > I believe that everyone in this list has seen the benefit of using Rcpp to > incorporate C++ code and develop R packages, but it's also the fact that > currently there is rarely a complete reference which documents every detail > of

Re: [Rcpp-devel] Rcpp API Reference

2014-09-04 Thread Tim Keitt
On Thu, Sep 4, 2014 at 9:13 AM, Qiang Kou wrote: > It will be great, however, it is too hard to maintain a hand-crafted > document. > > Rcpp is changing really rapidly. > > For users who really need to know all the details of every class, I > believe they are comfortable with Doxygen. > Or perha

Re: [Rcpp-devel] Rcpp API Reference

2014-09-04 Thread Qiang Kou
It will be great, however, it is too hard to maintain a hand-crafted document. Rcpp is changing really rapidly. For users who really need to know all the details of every class, I believe they are comfortable with Doxygen. For other users, the detailed documents for examples and testing may be m

Re: [Rcpp-devel] Rcpp API Reference

2014-09-04 Thread Tim Keitt
This is tremendously helpful and exactly what is needed. Thank you for putting that together. THK On Wed, Sep 3, 2014 at 10:03 PM, Yixuan Qiu wrote: > Dear all, > I believe that everyone in this list has seen the benefit of using Rcpp to > incorporate C++ code and develop R packages, but it's

Re: [Rcpp-devel] Rcpp API Reference

2014-09-04 Thread Smith, Dale (Norcross)
Doxygen is so useful because it’s automatically generated. Keeping up with additions or changes with hand-crafted API documentation is not easy. You should at least include a link to the Rcpp Gallery. http://gallery.rcpp.org/ I’d prefer detailed documentation for the unit tests as they are very