updating user documentation. another update required

manual/manual-client/Makefile

@@ -1,6 +1,5 @@
 DESTDIR?=../docs
 
-
 #manual-api manual-calwiz manual-client manual-gui manual-main
 
 
@@ -11,34 +10,50 @@ MAINTEXS= slsDetectorClientHowTo.tex
 DVIS = $(MAINTEXS:.tex=.dvi)
 PSS = $(MAINTEXS:.tex=.ps)
 PDFS = $(MAINTEXS:.tex=.pdf)
-
-#TARGETS=$(join $(DESTDIR)/, $(notdir $(MAINTEXS:.tex=.pdf)))
-
-#destdir?!?!?
-
-
-
-DVIS = $(MAINTEXS:.tex=.dvi)
-PSS = $(MAINTEXS:.tex=.ps)
-PDFS = $(MAINTEXS:.tex=.pdf)
-
 HTMLS = $(MAINTEXS:%.tex=%)
 
 
-#destdir?!?!?
-
-all: $(PDFS) $(HTMLS)
+all: docs pdf html
 	echo $(PWD)
 	echo $(PDFS)
 	echo $(HTMLS)
+	
+docs: 	createdocs docspdf docshtml removedocs
+	
+createdocs: slsDetectorClient.doxy slsDetectorCommand.cpp
+	doxygen slsDetectorClient.doxy	
+
+docspdf: 
+	cd slsDetectorClientDocs/latex && make 
+	$(shell test -d $(DESTDIR) || mkdir -p $(DESTDIR))
+	$(shell test -d $(DESTDIR)/pdf || mkdir -p $(DESTDIR)/pdf)
+	mv slsDetectorClientDocs/latex/refman.pdf $(DESTDIR)/pdf/slsDetectorClientDocs.pdf
+
+docshtml: 
+	$(shell test -d $(DESTDIR) || mkdir -p $(DESTDIR))
+	$(shell test -d $(DESTDIR)/html || mkdir -p $(DESTDIR)/html)
+	$(shell test -d $(DESTDIR)/html/slsDetectorClientDocs && rm -r $(DESTDIR)/html/slsDetectorClientDocs)
+	mv slsDetectorClientDocs/html $(DESTDIR)/html/slsDetectorClientDocs
+	
+removedocs:
+	rm -rf 	slsDetectorClientDocs;
 
 pdf: $(PDFS)
+	$(shell test -d $(DESTDIR) || mkdir -p $(DESTDIR))
+	$(shell test -d $(DESTDIR)/pdf || mkdir -p $(DESTDIR)/pdf)
+	mv $(PDFS) $(DESTDIR)/pdf	
+	
 
 html: $(HTMLS)
 
 $(HTMLS): $(MAINTEXS)
+	$(shell test -d $(DESTDIR) || mkdir -p $(DESTDIR))
+	$(shell test -d $(DESTDIR)/html || mkdir -p $(DESTDIR)/html)
+	$(shell test -d $(DESTDIR)/html/$@ && rm -r $(DESTDIR)/html/$@)
 	latex $@.tex
 	latex2html -split 4 $@.tex
+	mv $@ $(DESTDIR)/html
+	
 
 
 %.dvi : %.tex
@@ -54,4 +69,10 @@ $(HTMLS): $(MAINTEXS)
 
 
 clean:
+	echo "cleaning for manual-client"
 	rm -rf *.aux *.log *.toc *.out $(DVIS) $(PSS) $(PDFS) $(HTMLS)
+	rm -rf slsDetectorClientDocs
+	rm -rf $(DESTDIR)/html/slsDetectorClientDocs
+	rm -rf $(DESTDIR)/html/slsDetectorClientHowTo
+	rm -rf $(DESTDIR)/pdf/slsDetectorClientDocs.pdf
+	rm -rf $(DESTDIR)/pdf/slsDetectorClientHowTo.pdf

manual/manual-client/slsDetectorClient.doxy

@@ -0,0 +1,86 @@
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
+# documentation are documented, even if no documentation was available. 
+# Private class members and static file members will be hidden unless 
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL            = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
+# will be included in the documentation.
+
+EXTRACT_PRIVATE        = NO
+
+
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file 
+# will be included in the documentation.
+
+EXTRACT_STATIC         = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES  = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS  = YES
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespace are hidden.
+
+EXTRACT_ANON_NSPACES   = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS     = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES     = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS  = NO
+
+INTERNAL_DOCS = NO
+
+SHOW_INCLUDE_FILES = NO
+
+SHOW_FILES = NO
+
+SHOW_NAMESPACES = NO
+
+COMPACT_LATEX = YES
+
+PAPER_TYPE = a4
+
+PDF_HYPERLINKS = YES
+
+USE_PDFLATEX = YES
+
+LATEX_HIDE_INDICES = YES
+
+
+PREDEFINED           = __cplusplus
+
+INPUT            = slsDetectorCommand.cpp 
+
+OUTPUT_DIRECTORY = slsDetectorClientDocs

manual/manual-client/slsDetectorClientHowTo.tex

@@ -580,7 +580,7 @@ Advanced commands to configure the detector system. Should be left to the config
 \item[free]  Avoid using it. Frees the shared memory. 
 \end{description}
 Settable communication parameters:
-\start{description}
+\begin{description}
 \item[txndelay\_left] \E advanced: Set transmission delay of sending the left port frame  
 \item[txndelay\_right] \E advanced: Set transmission delay of sending the right port frame
  \item[txndelay\_frame] \E advanced: Set transmission delay of sending the entire frame In addition to left and right. This value has to be greater than the maximum of the transmission delays of each port.    

manual/manual-client/slsDetectorCommand.cpp

@@ -0,0 +1 @@
+../../slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp