[prev in list] [next in list] [prev in thread] [next in thread] 

List:       vtk-developers
Subject:    [vtk-developers] .SECTION References
From:       Nasztanovics Ferenc <naszta () naszta ! hu>
Date:       2010-02-15 9:53:08
Message-ID: 5BB7B19DABF195469391CA6081FCB0F401FF8B4404 () VMBX116 ! ihostexchange ! net
[Download RAW message or body]

When we contribute a class we should following this rule:

// .SECTION Thanks
// (put your name, email, and institution here) wrote this class. (If
there are any links/references related to the algorithm, you can put
them here)

I think a separated references section would be nice. In that point the author could \
make a reference list of the basics of algorithms like in a journal article. (e.g.: \
in Random() at vtkMath would be much better (elegant) a reference in the doxygen \
generated help file: Now in cpp:
  // Based on code in "Random Number Generators: Good Ones are Hard to Find,"
  // by Stephen K. Park and Keith W. Miller in Communications of the ACM,
  // 31, 10 (Oct. 1988) pp. 1192-1201.
  // Borrowed from: Fuat C. Baran, Columbia University, 1988.

Future in header:
// .SECTION References:
// - Based on code in "Random Number Generators: Good Ones are Hard to Find, by \
Stephen K. Park and Keith W. Miller in Communications of the ACM, 31, 10 (Oct. 1988) \
pp. 1192-1201. // - Borrowed from: Fuat C. Baran, Columbia University, 1988.
)

Best regards,

Naszta
_______________________________________________
Powered by www.kitware.com

Visit other Kitware open-source projects at \
http://www.kitware.com/opensource/opensource.html

Follow this link to subscribe/unsubscribe:
http://www.vtk.org/mailman/listinfo/vtk-developers


[prev in list] [next in list] [prev in thread] [next in thread]