[beast: 29/95] SFI: document namespaces
- From: Tim Janik <timj src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [beast: 29/95] SFI: document namespaces
- Date: Mon, 25 Mar 2013 00:38:56 +0000 (UTC)
commit 198d4d16a31e16d66d925f4fc742c2b56cc6190a
Author: Tim Janik <timj gnu org>
Date: Sun Mar 17 06:17:24 2013 +0100
SFI: document namespaces
sfi/sficxx.hh | 2 ++
sfi/sfidl-utils.hh | 5 ++++-
2 files changed, 6 insertions(+), 1 deletions(-)
---
diff --git a/sfi/sficxx.hh b/sfi/sficxx.hh
index 55b9645..38bc348 100644
--- a/sfi/sficxx.hh
+++ b/sfi/sficxx.hh
@@ -6,6 +6,8 @@
#include <string>
#include <string.h>
#include <new>
+
+/// The Sfi namespace contains utilities for synthesis.
namespace Sfi {
typedef SfiBool Bool; // FIXME: use bool instead?
typedef SfiInt Int;
diff --git a/sfi/sfidl-utils.hh b/sfi/sfidl-utils.hh
index b52d16e..552cd21 100644
--- a/sfi/sfidl-utils.hh
+++ b/sfi/sfidl-utils.hh
@@ -5,12 +5,15 @@
#include <birnet/birnet.hh>
#include <list>
#include <vector>
+
+/// The Sfidl namespace contains implementation and API of the Sfi IDL compiler.
namespace Sfidl {
/* lots of helpers like string_from_int, but also typedefs like String */
using namespace Birnet;
/* common data structures */
using std::list;
using std::vector;
-}
+} // Sfidl
+
#endif /* _SFIDL_UTILS_HH_ */
/* vim:set ts=8 sts=2 sw=2: */
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]