* gdcm/Doc many doxygen changes:

[gdcm.git] / Doc / DoxyIntroduction.txt

diff --git a/Doc/DoxyIntroduction.txt b/Doc/DoxyIntroduction.txt
new file mode 100644 (file)
index 0000000..8473462
--- /dev/null
+++ b/Doc/DoxyIntroduction.txt
@@ -0,0 +1,44 @@
+/**
+ * \page DoxyIntroduction Introduction
+ *
+ *  Gdcm -which stands for Gnu DiCoM- is yet another C++ library
+ *  dedicated to reading/parsing and writing
+ *  <A HREF="http://medical.nema.org/">Dicom</A> files.
+ *
+ * \section DoxyFeatures Features
+ *  - gdcm implements the
+ *    <A HREF="http://www.dclunie.com/dicom-status/status.html">
+ *    dicom base standard part 5</A> that concentrates on image file format.
+ *    Hence gdcm supports the following formats:
+ *    -# ACR-NEMA version 1 and 2
+ *    -# Dicom version 3.
+ *  - gdcm is distributed with 
+ *    <A HREF="http://www.gnu.org/copyleft/lesser.html">LPGL</A>
+ *    for the license.
+ *  - gdcm targets both GNU/Un*ces and Windows/VC++ (see \ref
+ *    DoxyRequirements).
+ *  - gdcm comes with \ref DoxyPythonComplete it's
+ *    <A HREF="http://www.python.org">Python</A> wrappers.
+ * .
+ *
+ * \section DoxyLimitation Design limitations
+ *  - gdcm does not implement any other part of the Dicom base standard as
+ *    opposed to
+ *    <A HREF="http://www.erl.wustl.edu/DICOM/ctn.html">CTN</A>
+ *    or
+ *    <A HREF="http://www.offis.de/projekte/ig/dicom/soft-docs/soft01_d.html">
+ *    DCMTK</A>. In particular gdcm is not aware of:
+ *    -# the Dicom network file exchange protocol.
+ *    -# the Dicom media storage formats.
+ *    .
+ *  .
+ *
+ *
+ * \section DoxyTODO Features to come (TODO list)
+ *  - offer Dicom jpeg compressed image support,
+ *  - enable Dicom header parsing of sequences and overlays,
+ *  - distribute a <A HREF="http://public.kitware.com/VTK/">VTK</A>
+ *    thin wrapper of gdcm (essentially a vtkGdcmImageReader).
+ *  .
+ * Installing gdcm and gdcmPyton: \ref DoxyInstallation 
+ */