[various] Improve documentation

Output file must be preallocated.
2016-07-11 14:53:03 +01:00
parent ceffa5f5c4
commit 4779fb9b80
16 changed files with 127 additions and 13 deletions
--- a/base/output_file_requirements.h
+++ b/base/output_file_requirements.h
@@ -0,0 +1,14 @@
+#ifndef BASE_OUTPUT_FILE_REQUIREMENTS_H
+#define BASE_OUTPUT_FILE_REQUIREMENTS_H
+
+#include <string>
+
+//----------------------------------------------------------------
+
+namespace base {
+	void check_output_file_requirements(std::string const &path);
+}
+
+//----------------------------------------------------------------
+
+#endif