home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / namespace_documentation.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-01-23  |  3.4 KB  |  108 lines
  1. #ifndef K3DSDK_NAMESPACE_DOCUMENTATION_H
  2. #define K3DSDK_NAMESPACE_DOCUMENTATION_H
  3.  
  4. /** \file
  5.     \brief This do-nothing file is used to provide a central point for documenting the K-3D library namespaces for use with Doxygen
  6.     \author Timothy M. Shead <tshead@k-3d.com>
  7. */
  8.  
  9. /// Namespace reserved for the boost library, see http://www.boost.org
  10. namespace boost
  11. {
  12.     /// Namespace reserved for the boost filesystem library, see http://www.boost.org/libs/filesystem
  13.     namespace filesystem {}
  14.     /// Namespace reserved for the spirit parser framework, see http://spirit.sourceforge.net
  15.     namespace spirit {}
  16. }
  17.  
  18. /// Namespace reserved for the gdkmm C++ wrappers for GTK, see http://gtkmm.sourceforge.net
  19. namespace Gdk {}
  20.  
  21. /// Namespace reserved for the glibmm C++ wrappers for glib, see http://gtkmm.sourceforge.net
  22. namespace Glib {}
  23.  
  24. /// Namespace reserved for the gtkmm C++ wrappers for GTK, see http://gtkmm.sourceforge.net
  25. namespace Gtk {}
  26.  
  27. /// Namespace reserved for K-3D plugin modules
  28. namespace module {}
  29.  
  30. /// Namespace reserved for all public symbols in the K-3D SDK
  31. namespace k3d
  32. {
  33.  
  34. /// Contains commonly-used plugin object class identifiers, so specific plugin objects can be instantiated
  35. namespace classes {}
  36.  
  37. /// Contains constraint objects used with k3d::data and related objects
  38. namespace constraint {}
  39.  
  40. /// Contains private implementation details for the k3d API
  41. namespace detail {}
  42.  
  43. /// Contains a boost::spirit grammar and related objects for parsing numeric expressions
  44. namespace expression {}
  45.  
  46. /// Contains functions and objects to simplify working with the OpenGL API, sese http://www.opengl.org
  47. namespace gl
  48. {
  49.     /// Contains private implementation details of the k3d::gl API
  50.     namespace detail {}
  51. }
  52.  
  53. /// Contains private implementation details for the k3d API (deprecated, use k3d::detail for new code instead)
  54. namespace implementation_private {}
  55.  
  56. /// Contains objects for use with libsigc++ signals
  57. namespace signal {}
  58.  
  59. /// Contains objects for storing and converting real-world units-of-measure
  60. namespace measurement
  61. {
  62.     /// Contains policy objects for converting between real-world units-of-measure
  63.     namespace conversion {}
  64. } // namespace measurement
  65.  
  66. /// Contains functions and classes used to make object serialization & persistence easier
  67. namespace persistence {}
  68.  
  69. /// Contains functions and classes used to export easily-modifiable "properties" from objects
  70. namespace property {}
  71.  
  72. /// Contains functions and classes used to generate RenderMan compatible descriptions of a document
  73. namespace ri
  74. {
  75.     /// Contains private implementation details of the k3d::ri API
  76.     namespace detail {}
  77. }
  78.  
  79. /// Contains functions and classes for working with RenderMan Shading Language data
  80. namespace sl {}
  81.  
  82. /// Contains functions and classes used to abstract away differences in operating systems / platforms
  83. namespace system {}
  84.  
  85. /// Contains functions and classes for working with XML data
  86. namespace xml
  87. {
  88.     /// Contains private implementation details of the k3d::xml API
  89.     namespace detail {}
  90. }
  91.  
  92. } // namespace k3d
  93.  
  94. /// Namespace reserved for the libsigc++ signal library, see http://libsigc.sourceforge.net
  95. namespace sigc {}
  96.  
  97. /// Namespace reserved for the libsigc++ signal library (compatibility layer), see http://libsigc.sourceforge.net
  98. namespace SigC {}
  99.  
  100. /// Namespace reserved for the C++ Standard Library
  101. namespace std {}
  102.  
  103. /// Namespace reserved for the ImageMagick C++ binding, see http://studio.imagemagick.org/Magick++
  104. namespace Magick {}
  105.  
  106. #endif // !K3DSDK_NAMESPACE_DOCUMENTATION_H
  107.  
  108.