<div dir="ltr"><div><div><div><div><div>Hi all,<br></div>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 the current stage, and hopefully it could be synchronized to Doxygen when the content is rich enough.<br>Another more technical reason that I feel hard to control Doxygen is that Rcpp uses some macros and includes to define constructors and functions, which cannot be recognized by Doxygen directly. I'll try to figure it out in the future.<br></div>Unit tests are helpful indeed, and interestingly they are also wonderful minimal examples for each public member function. My next plan is to embed these unit test examples into the documentation itself.<br></div>Once again, thanks for all these inspiring ideas.<br><br><br></div>Best,<br></div>Yixuan<br></div><div class="gmail_extra"><br><br><div class="gmail_quote">2014-09-04 9:29 GMT-04:00 Smith, Dale (Norcross) <span dir="ltr"><<a href="mailto:Dale.Smith@fiserv.com" target="_blank">Dale.Smith@fiserv.com</a>></span>:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">





<div link="blue" vlink="purple" lang="EN-US">
<div>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Doxygen is so useful because it’s automatically generated. Keeping up with additions or changes with hand-crafted API documentation is not easy.<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">You should at least include a link to the Rcpp Gallery.<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><a href="http://gallery.rcpp.org/" target="_blank">http://gallery.rcpp.org/</a><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">I’d prefer detailed documentation for the unit tests as they are very useful.<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><u></u> <u></u></span></p>
<p class="MsoNormal"><b><span style="font-size:10.0pt;font-family:"Arial","sans-serif";color:#1f497d">Dale Smith, Ph.D.<u></u><u></u></span></b></p>
<p class="MsoNormal"><span style="font-size:10.0pt;font-family:"Arial","sans-serif";color:#1f497d">Senior Financial Quantitative Analyst<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:10.0pt;font-family:"Arial","sans-serif";color:#1f497d" lang="EN-GB">Financial & Risk Management Solutions<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:10.0pt;font-family:"Arial","sans-serif";color:#1f497d" lang="EN-GB">Fiserv<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:10.0pt;font-family:"Arial","sans-serif";color:#1f497d">Office: <a href="tel:678-375-5315" value="+16783755315" target="_blank">678-375-5315</a><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><a href="http://www.fiserv.com/" target="_blank">www.fiserv.com</a></span><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><u></u> <u></u></span></p>
<p class="MsoNormal"><b><span style="font-size:10.0pt;font-family:"Tahoma","sans-serif"">From:</span></b><span style="font-size:10.0pt;font-family:"Tahoma","sans-serif""> <a href="mailto:rcpp-devel-bounces@r-forge.wu-wien.ac.at" target="_blank">rcpp-devel-bounces@r-forge.wu-wien.ac.at</a> [mailto:<a href="mailto:rcpp-devel-bounces@r-forge.wu-wien.ac.at" target="_blank">rcpp-devel-bounces@r-forge.wu-wien.ac.at</a>]
<b>On Behalf Of </b>Yixuan Qiu<br>
<b>Sent:</b> Wednesday, September 03, 2014 11:03 PM<br>
<b>To:</b> <a href="mailto:rcpp-devel@lists.r-forge.r-project.org" target="_blank">rcpp-devel@lists.r-forge.r-project.org</a><br>
<b>Subject:</b> [Rcpp-devel] Rcpp API Reference<u></u><u></u></span></p><div><div class="h5">
<p class="MsoNormal"><u></u> <u></u></p>
<div>
<div>
<div>
<div>
<p class="MsoNormal">Dear all,<br>
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 the classes and functions inside
 Rcpp.<br>
To make this situation a little bit better, recently I've created a project that aims to accomplish this long run target. A quick view of what it looks like is available at my site:
<a href="http://statr.me/rcpp-note/" target="_blank">http://statr.me/rcpp-note/</a><br>
Basically it's like the Doxygen documentation, but the content here was manually added rather than extracted from the Rcpp source code. For now I've finished some of the most commonly used classes in Rcpp, and do hope that more people are joining in, either
 by reviewing and correcting the existing documentation, or contributing your own knowledge.<br>
I wish this project would be helpful for those who want to use Rcpp in their code and packages, and be more powerful and complete with the help of you experts in this list. If you are also interested in, don't hesistate to go to the project repository (<a href="https://github.com/yixuan/Rcpp-note" target="_blank">https://github.com/yixuan/Rcpp-note</a>),
 reporting mistakes, contributing document or giving suggestions.<u></u><u></u></p>
</div>
<p class="MsoNormal" style="margin-bottom:12.0pt">Happy Rcpping!<br>
<br>
<u></u><u></u></p>
</div>
<p class="MsoNormal">Best,<u></u><u></u></p>
</div>
<p class="MsoNormal">Yixuan<br clear="all">
<u></u><u></u></p>
<div>
<div>
<div>
<p class="MsoNormal"><br>
-- <br>
Yixuan Qiu <<a href="mailto:yixuan.qiu@cos.name" target="_blank">yixuan.qiu@cos.name</a>><br>
Department of Statistics,<br>
Purdue University<u></u><u></u></p>
</div>
</div>
</div>
</div>
</div></div></div>
</div>

</blockquote></div><br><br clear="all"><br>-- <br>Yixuan Qiu <<a href="mailto:yixuan.qiu@cos.name" target="_blank">yixuan.qiu@cos.name</a>><br>Department of Statistics,<br>Purdue University<br>
</div>