Commit 9ed79304 authored by LEGEARD Luc's avatar LEGEARD Luc
Browse files

better doxygen file

parent 4f0e65c7
......@@ -8,5 +8,7 @@
/html/*
/sources/html/*
/sources/latex/*
/html/*
/latex/*
/sources/TODO.txt
*.exe
Author : Luc Legeard
Information
-----------
legeard @ ganil.fr
---------------
## Intoduction
This package MFMlib is a complete C++ library to decode or encode MFM frame.
It generates a libMFM.a which can be linked to your own code
A usefull executable "MFMtest.exe" can test you MFM run files or generate MFM frames in a file with random data
It generates a libMFM.a which can be linked to your own code.
A usefull executable "MFMtest.exe" can tests you MFM run files or generate MFM frames in a file with random data.
-------------------------------------------------------------------------------------------------
Build and Installation (options are in brackets)
-----------------------
## Build and Installation (options are in brackets)
cd build ( if build isn't created , make it! (in this case, beside source directory))
cmake -DCMAKE_INSTALL_PREFIX=../ ../sources/ [-DDEBUG=YES] [-DNO_MFMNXML=YES] [-DMYTINYXMLDIR=/the/directory/where/libtinyxml.so/is/]
make
make install-DDEBUG=YES
-------------------------------------------------------------------------------------------------
Options :
### Build Options :
- add "-DDEBUG=YES" to activate debug compilation mode
- If tinyxml library is not installed or not necessary MFM can be compiled without tinyxml add option "-DNO_MFMNXML=YES"
- to add your own tynixml library
download tynixml from http://www.grinninglizard.com/tinyxml/.
In tinyxml directory
In tinyxml directory,
edit Makefile and for adding -fPIC option change lines
/////////////////////////////////////////////////////////////
# Rules for compiling source files to object files
Rules for compiling source files to object files :
~~~
%.o : %.cpp
${CXX} -c ${CXXFLAGS} ${INCS} $< -o $@
%.o : %.c
%.o : %.c
${CC} -c ${CFLAGS} ${INCS} $< -o $@
/////////////////////////////////////////////////////////////
~~~
to
/////////////////////////////////////////////////////////////
# Rules for compiling source files to object files
Rules for compiling source files to object files
~~~
%.o : %.cpp
${CXX} -fPIC -c ${CXXFLAGS} ${INCS} $< -o $@
%.o : %.c
%.o : %.c
${CC} -fPIC -c ${CFLAGS} ${INCS} $< -o $@
lib: tinyxml.o tinyxmlparser.o tinyxmlerror.o tinystr.o
${CC} -shared -fPIC ${CFLAGS} ${INCS} tinyxml.o tinyxmlparser.o tinyxmlerror.o tinystr.o -o libtinyxml.so
/////////////////////////////////////////////////////////////
~~~
compile with a "make lib" tynixml
to produce tynixml.so
......@@ -54,15 +67,17 @@ The new cmake command become
cmake -DMYTINYXMLDIR=/the/directory/where/libtinyxml.so/is/ -DCMAKE_INSTALL_PREFIX=../ ../sources/
-------------------------------------------------------------------------------------------------
Usage
-----
## Usage and Documentation
usage "MFMtest.exe --help" for help
MFMtest.exe --help
In a tuto directory, you have a example usage of MFMlib for you own C++ code
In a tuto directory, you have a example usage of MFMlib for you own C++ code
For code documentation , execute "doxygen Doxyfile.MFM" in sources directory , so browse the html directory
-------------------------------------------------------------------------------------------------
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
/**
\mainpage MFM Library general information
*
**\verbinclude "README.md"
* <a href="README.md"></a>,
**/
#include <iostream>
using namespace std;
#include <unistd.h>
......@@ -27,6 +35,7 @@ enum WorkMode {WRITE_FRAMES =0x00,READ_FRAMES =0x01,EXTRACT_FRAMES=0x02,EXTRACT_
MFMCommonFrame * fFrame;
MFMCoboFrame * fCoboframe;
MFMCoboTopoFrame * fCobotopoframe;
MFMExogamFrame * fExoframe;
MFMDiamantFrame * fDiamantframe;
MFMEbyedatFrame * fEbyframe;
......
#define MFM_VERSION "v21.09.14"
#define MFM_VERSION "v21.09.20"
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment