* add documentation of the cool (?) "print with format" feature

* move the ioformat.cpp test to a documentation example
* rename IoFormat => IOFormat

1 files changed, 14 insertions, 0 deletions

diff --git a/doc/snippets/IOFormat.cpp b/doc/snippets/IOFormat.cpp
new file mode 100644
index 000000000..9db70980c
--- /dev/null
+++ b/doc/snippets/IOFormat.cpp
@@ -0,0 +1,14 @@
+std::string sep = "\n----------------------------------------\n";
+Matrix3f m1;
+m1 << 1.111111, 2, 3.33333, 4, 5, 6, 7, 8.888888, 9;
+
+IOFormat CommaInitFmt(4, Raw, ", ", ", ", "", "", " << ", ";");
+IOFormat CleanFmt(4, AlignCols, ", ", "\n", "[", "]");
+IOFormat OctaveFmt(4, AlignCols, ", ", ";\n", "", "", "[", "]");
+IOFormat HeavyFmt(4, AlignCols, ", ", ";\n", "[", "]", "[", "]");
+
+std::cout << m1 << sep;
+std::cout << m1.format(CommaInitFmt) << sep;
+std::cout << m1.format(CleanFmt) << sep;
+std::cout << m1.format(OctaveFmt) << sep;
+std::cout << m1.format(HeavyFmt) << sep;