Changeset 1791 for code/trunk/src/util/Clipboard.h

Timestamp:

Sep 16, 2008, 3:46:25 AM (16 years ago)

Author:

landauf

Message:

added comments to all my classes in util

File:

• code/trunk/src/util/Clipboard.h (modified) (2 diffs)

code/trunk/src/util/Clipboard.h

@@ -27 +27 @@
  */
 
+/**
+    @file Clipboard.h
+    @brief Some functions to exchange text between the OS clipboard and Orxonox.
+
+    Use fromClipboard() to get text from the clipboard (if there is any text) and
+    toClipboard(text) to put text into the clipboard.
+
+    Those functions can only work properly if there's an OS-specific implementation.
+    If an OS isn't supported, the clipboard only works within Orxonox, but exchange
+    with other programs isn't possible.
+*/
+
 #ifndef _Clipboard_H__
 #define _Clipboard_H__
@@ -35 +47 @@
 
 
-_UtilExport bool toClipboard(std::string text);
+_UtilExport bool toClipboard(const std::string& text);
 _UtilExport std::string fromClipboard();