From a7dab9a257087309d52d53cd5e1dfff52eecacec Mon Sep 17 00:00:00 2001 From: Dhanya Maliakal Date: Tue, 22 Aug 2017 19:42:52 +0200 Subject: [PATCH] updating user documentation. another update required --- slsDetectorSoftware/.gitignore | 1 - slsDetectorSoftware/Makefile | 29 +------ .../include/slsReceiverUsers.h | 2 +- slsDetectorSoftware/slsDetectorClient.doxy | 86 ------------------- slsDetectorSoftware/slsDetectorUsers.doxy | 86 ------------------- 5 files changed, 3 insertions(+), 201 deletions(-) delete mode 100644 slsDetectorSoftware/slsDetectorClient.doxy delete mode 100644 slsDetectorSoftware/slsDetectorUsers.doxy diff --git a/slsDetectorSoftware/.gitignore b/slsDetectorSoftware/.gitignore index 6a4d1707d..fc05915b5 100644 --- a/slsDetectorSoftware/.gitignore +++ b/slsDetectorSoftware/.gitignore @@ -1,4 +1,3 @@ *.o *~ #*# -slsDetectorClientDocs/ diff --git a/slsDetectorSoftware/Makefile b/slsDetectorSoftware/Makefile index 7c8f501ad..850edef3f 100644 --- a/slsDetectorSoftware/Makefile +++ b/slsDetectorSoftware/Makefile @@ -2,7 +2,6 @@ include ../Makefile.include DESTDIR ?= ../bin LIBDIR ?= $(DESTDIR) -DOCDIR ?= docs CFLAGS= -g -DC_ONLY -fPIC @@ -33,34 +32,10 @@ $(info ) OBJS = $(SRC_CLNT:%.cpp=%.o) -.PHONY: all intdoc doc htmldoc package clean +.PHONY: all package clean all: package $(SRC_CLNT) -intdoc: $(SRC_H) $(SRC_CLNT) - doxygen doxy.config - -doc: $(DOCDIR)/pdf/slsDetectorUsersDocs.pdf - -$(DOCDIR)/pdf/slsDetectorUsersDocs.pdf: slsDetectorUsersDocs - cd slsDetectorUsersDocs/latex && make - $(shell test -d $(DOCDIR) || mkdir -p $(DOCDIR)) - $(shell test -d $(DOCDIR)/pdf || mkdir -p $(DOCDIR)/pdf) - cp slsDetectorUsersDocs/latex/refman.pdf $(DOCDIR)/pdf/slsDetectorUsersDocs.pdf - - -htmldoc: $(DOCDIR)/html/slsDetectorUsersDocs - -$(DOCDIR)/html/slsDetectorUsersDocs: slsDetectorUsersDocs - $(shell test -d $(DOCDIR) || mkdir -p $(DOCDIR)) - $(shell test -d $(DOCDIR)/html || mkdir -p $(DOCDIR)/html) - $(shell test -d $(DOCDIR)/html/slsDetectorUsersDocs && rm -r $(DOCDIR)/html/slsDetectorUsersDocs) - cp -r slsDetectorUsersDocs/html $(DOCDIR)/html/slsDetectorUsersDocs - -slsDetectorUsersDocs: slsDetectorUsers.doxy slsDetector/slsDetectorUsers.h slsDetector/slsDetectorUsers.cpp slsDetectorAnalysis/detectorData.h - doxygen slsDetectorUsers.doxy - - mythenVirtualServer: $(SRC_MYTHEN_SVC) cd mythenDetectorServer && make -f Makefile.virtual DESTDIR=$(DESTDIR) @@ -90,7 +65,7 @@ $(DESTDIR)/libSlsDetector.a: $(OBJS) mv libSlsDetector.a $(DESTDIR) clean: - rm -rf $(DESTDIR)/libSlsDetector.a $(DESTDIR)/libSlsDetector.so core docs/* slsDetectorUsersDocs $(OBJS) + rm -rf $(DESTDIR)/libSlsDetector.a $(DESTDIR)/libSlsDetector.so core $(OBJS) cd diff --git a/slsDetectorSoftware/include/slsReceiverUsers.h b/slsDetectorSoftware/include/slsReceiverUsers.h index d73c332c0..c8727f200 120000 --- a/slsDetectorSoftware/include/slsReceiverUsers.h +++ b/slsDetectorSoftware/include/slsReceiverUsers.h @@ -1 +1 @@ -../slsReceiver/slsReceiverUsers.h \ No newline at end of file +../../slsReceiverSoftware/include/slsReceiverUsers.h \ No newline at end of file diff --git a/slsDetectorSoftware/slsDetectorClient.doxy b/slsDetectorSoftware/slsDetectorClient.doxy deleted file mode 100644 index 2d955c610..000000000 --- a/slsDetectorSoftware/slsDetectorClient.doxy +++ /dev/null @@ -1,86 +0,0 @@ -# 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 = slsDetector/slsDetectorCommand.cpp - -OUTPUT_DIRECTORY = ../manual/slsDetectorClientDocs diff --git a/slsDetectorSoftware/slsDetectorUsers.doxy b/slsDetectorSoftware/slsDetectorUsers.doxy deleted file mode 100644 index 6f3674742..000000000 --- a/slsDetectorSoftware/slsDetectorUsers.doxy +++ /dev/null @@ -1,86 +0,0 @@ -# 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 = slsDetector/slsDetectorUsers.h slsDetectorAnalysis/detectorData.h - -OUTPUT_DIRECTORY = slsDetectorUsersDocs