Revision: 75897
http://sourceforge.net/p/brlcad/code/75897
Author: brlcad
Date: 2020-05-23 17:05:51 +0000 (Sat, 23 May 2020)
Log Message:
-----------
mention the EXPORT markers now required
Modified Paths:
--------------
brlcad/trunk/HACKING
Modified: brlcad/trunk/HACKING
===================================================================
--- brlcad/trunk/HACKING 2020-05-23 17:03:59 UTC (rev 75896)
+++ brlcad/trunk/HACKING 2020-05-23 17:05:51 UTC (rev 75897)
@@ -831,19 +831,16 @@
All public library functions and most private or application functions
should be appropriately documented using Doxygen/Javadoc style
-comments. Without getting into the advanced details, this minimally
-means that you need to add an additional asterisk to a comment that
-precedes your functions:
+comments. This minimally means that you need to add an additional
+asterisk to a comment that precedes your functions. Public functions
+must be exported and imported using per-library macros that precede
+public symbol declarations (e.g., BU_EXPORT int func();). Example:
/**
* Computes the answer to the meaning of life, the universe, and
* everything.
*/
-int
-the_answer(void)
-{
- return 42;
-}
+MYLIB_EXPORT int mylib_function();
TESTING & DEBUGGING
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
