diff --git a/.gitignore b/.gitignore index 18ed277ee9..b72e166cc7 100644 --- a/.gitignore +++ b/.gitignore @@ -17,6 +17,7 @@ wpilibj/wpilibJavaJNI/nivision/*_arm.ini wpilibj/wpilibJavaJNI/nivision/*.java wpilibj/wpilibJavaJNI/nivision/nivision_funcs.txt wpilibj/wpilibJavaJNI/nivision/imaqdx_funcs.txt +doxygen.log # Created by the jenkins test script test-reports diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000000..99f0e18a51 --- /dev/null +++ b/build.gradle @@ -0,0 +1,186 @@ +import org.apache.tools.ant.taskdefs.condition.Os + +// This regex matches either a Windows or Unix style file separator, then the lib part of the library, +// then the name of the library itself, and finally the .so extension at the end. The name of the library +// is in the libName capture group, which is extracted and used for the linker flags +def libPattern = /.*((\\/|\\).*)+lib(?.+).so$/ +def niLibraryArgs = [] +def wpiLibraryArgs = [] +def niLibraryPath = file('ni-libraries').path + +// The NI Library tree includes all non-wpi libraries, which is everything that doesn't have libwpi in the name +def niLibraryTree = fileTree(niLibraryPath) +niLibraryTree.include '*.so' +niLibraryTree.exclude '*libwpi*.so' + +// This adds all linker flags to the list of ni library linker flags +niLibraryTree.each { lib -> + def nameMatcher = (lib.path =~ libPattern) + if (nameMatcher[0].size() > 1) { + def name = nameMatcher.group('libName') + niLibraryArgs << '-l' + name + } +} + +// The WPI libraries are libraries in the ni-libraries folder that have libwpi in their names +def wpiLibraryTree = fileTree(niLibraryPath) +wpiLibraryTree.include '*libwpi*.so' + +// This adds all linker flags to the list of wpi library linker flags +wpiLibraryTree.each { lib -> + def nameMatcher = (lib.path =~ libPattern) + if (nameMatcher[0].size() > 1) { + def name = nameMatcher[0][1] + wpiLibraryArgs << '-l' + name + } +} + +// Shells out to maven for generates the eclipse plugins. +// TODO: Get gradle to build this natively, rather than relying on maven. A plugin exists to do this, called Wuff, but this needs more investigation +// https://github.com/akhikhl/wuff +task eclipsePlugins(type: Exec) { + description = 'Executes the maven build of the eclipse plugins' + group = 'WPILib' + workingDir 'eclipse-plugins' + if (Os.isFamily(Os.FAMILY_WINDOWS)) { + executable 'mvn.bat' + } else { + executable 'mvn' + } + args 'package' +} + +// Rather than a normal clean, which executes whenever the clean task is run, this must be manually invoked. This +// is because the maven processes is very verbose and takes a long time, checking all of the eclipse repositories +task cleanEclipsePlugins(type: Exec) { + description = 'Cleans the maven build of the eclipse plugins' + group = 'WPILib' + workingDir 'eclipse-plugins' + if (Os.isFamily(Os.FAMILY_WINDOWS)) { + executable 'mvn.bat' + } else { + executable 'mvn' + } + args 'clean' +} + +subprojects { + apply plugin: 'eclipse' + apply plugin: 'idea' + repositories { + mavenCentral() + mavenLocal() + } + + // Disables doclint in java 8. + if (JavaVersion.current().isJava8Compatible()) { + allprojects { + tasks.withType(Javadoc) { + options.addStringOption('Xdoclint:none', '-quiet') + } + } + } + + // Make sure that all maven publishing routines are run before the maven process starts + plugins.withType(MavenPublishPlugin).whenPluginAdded { + eclipsePlugins.dependsOn publishToMavenLocal + } + + plugins.withType(CppPlugin).whenPluginAdded { + model { + buildTypes { + debug + } + // Adds a custom toolchain for our compiler prefix and options + toolChains { + gcc(Gcc) { + target('arm') { + // We use a custom-built cross compiler with the prefix arm-frc-linux-gnueabi- + // If this ever changes, the prefix will need to be changed here + def compilerPrefix = 'arm-frc-linux-gnueabi-' + cppCompiler.executable = compilerPrefix + cppCompiler.executable + linker.executable = compilerPrefix + linker.executable + assembler.executable = compilerPrefix + assembler.executable + // Gradle auto-adds the -m32 argument to the linker and compiler. Our compiler only supports + // arm, and doesn't understand this flag, so it is removed from both + cppCompiler.withArguments { args -> + args << '-std=c++1y' << '-Wformat=2' << '-Wall' << '-Wextra' << '-Werror' << '-pedantic' + args << '-Wno-psabi' << '-Wno-unused-parameter' << '-fPIC' << '-O0' << '-g3' << '-rdynamic' + args.remove('-m32') + } + linker.withArguments { args -> + args << '-rdynamic' + args.remove('-m32') + } + } + } + } + + // The only platform is arm linux + platforms { + arm { + architecture 'arm' + operatingSystem 'linux' + } + } + } + + // This task adds the appropriate linker flags for the NI libraries + task addNiLibraryLinks() { + description = 'Adds the linker flags for the NI libraries in the ni-library folders' + group = 'WPILib' + doLast { + binaries.all { + tasks.withType(CppCompile) { + linker.args << '-L' + niLibraryPath + linker.args.addAll(niLibraryArgs) + } + } + model { + repositories { + libs(PrebuiltLibraries) { libs -> + // Loops through all .so files (except files matching *libwpi*.so) in ../ni-libraries + // and includes them for linking + niLibraryTree.each { niLib -> + libs.create(niLib) { + binaries.withType(SharedLibraryBinary) { + sharedLibraryFile = file(niLib.path) + } + } + } + } + } + } + } + } + + // This task adds the appropriate linker flags for the WPI libraries + task addWpiLibraryLinks() { + description = 'Adds the linker flags for the WPI libraries in the ni-library folders' + group = 'WPILib' + doLast { + binaries.all { + linker.args.addAll(wpiLibraryArgs) + } + model { + repositories { + libs(PrebuiltLibraries) { libs -> + // Loops through all libwpi*.so files in ../ni-libraries and includes them for linking + wpiLibraryTree.each { niLib -> + libs.create(niLib) { + binaries.withType(SharedLibraryBinary) { + sharedLibraryFile = file(niLib.path) + } + } + } + } + } + } + } + } + + // Whenever we add the WPI library links, we'll also need the ni libraries, so set up that dependency + addWpiLibraryLinks.dependsOn addNiLibraryLinks + } +} + diff --git a/driver-station/build.gradle b/driver-station/build.gradle new file mode 100644 index 0000000000..6a12fe2281 --- /dev/null +++ b/driver-station/build.gradle @@ -0,0 +1,4 @@ +apply plugin: 'java' +apply plugin: 'application' + +mainClassName = 'edu.wpi.first.driverstation.DriverStation' \ No newline at end of file diff --git a/eclipse-plugins/edu.wpi.first.wpilib.plugins.core.feature/pom.xml b/eclipse-plugins/edu.wpi.first.wpilib.plugins.core.feature/pom.xml index 492382a065..35a98728ba 100644 --- a/eclipse-plugins/edu.wpi.first.wpilib.plugins.core.feature/pom.xml +++ b/eclipse-plugins/edu.wpi.first.wpilib.plugins.core.feature/pom.xml @@ -1,15 +1,16 @@ - - 4.0.0 - edu.wpi.first.wpilib.plugins.core.feature - eclipse-feature + + 4.0.0 + edu.wpi.first.wpilib.plugins.core.feature + eclipse-feature - - edu.wpi.first.wpilib.plugins - edu.wpi.first.wpilib.plugins - 0.1.0.qualifier - .. - + + edu.wpi.first.wpilib.plugins + edu.wpi.first.wpilib.plugins + 0.1.0.qualifier + .. + diff --git a/eclipse-plugins/edu.wpi.first.wpilib.plugins.core/pom.xml b/eclipse-plugins/edu.wpi.first.wpilib.plugins.core/pom.xml index 6d978cbfc5..d8a0fd24b2 100644 --- a/eclipse-plugins/edu.wpi.first.wpilib.plugins.core/pom.xml +++ b/eclipse-plugins/edu.wpi.first.wpilib.plugins.core/pom.xml @@ -1,232 +1,233 @@ - - 4.0.0 - edu.wpi.first.wpilib.plugins.core - eclipse-plugin + 4.0.0 + edu.wpi.first.wpilib.plugins.core + eclipse-plugin - - edu.wpi.first.wpilib.plugins - edu.wpi.first.wpilib.plugins - 0.1.0.qualifier - .. - - - - DEVELOPMENT - ${project.build.directory}/tools-zip - + + edu.wpi.first.wpilib.plugins + edu.wpi.first.wpilib.plugins + 0.1.0.qualifier + .. + - - - WPILib Maven Repository - http://first.wpi.edu/FRC/roborio/maven/ - - + + DEVELOPMENT + ${project.build.directory}/tools-zip + - - - - . - - resources/configuration.properties - - true - - - - - maven-resources-plugin - 2.6 - - - copy-ant-resources-to-tools-zip - generate-sources - - copy-resources - - - ${tools-zip} - - - src/main/resources/tools-zip - - - - - - - - org.apache.maven.plugins - maven-dependency-plugin - 2.8 - - - - - fetch-jar-zip-dependencies - compile - - copy - - - - - edu.wpi.first.wpilib - RobotBuilder - 2.0.0-SNAPSHOT - ${tools-zip} - RobotBuilder.jar - - - edu.wpi.first.wpilib - SmartDashboard - 1.0.0-SNAPSHOT - ${tools-zip} - SmartDashboard.jar - - - edu.wpi.first.wpilib - sfx - zip - zip - ${tools-zip}/../ - sfx.zip - - - edu.wpi.first.wpilib.networktables - OutlineViewer - 1.0.0-SNAPSHOT - ${tools-zip} - OutlineViewer.jar - - - edu.wpi.first.wpilib - java-installer - 1.0-SNAPSHOT - ${tools-zip} - java-installer.jar - - - - false - true - - - - - - org.apache.maven.plugins - maven-antrun-plugin - 1.7 - - - - - set-version-info - - run - - process-sources - - - - - - - - - - - true - - + + + WPILib Maven Repository + http://first.wpi.edu/FRC/roborio/maven/ + + - - - generate-jar-zip - compile - - run - - - - - - - - - - - - - - - - org.eclipse.m2e - lifecycle-mapping - 1.0.0 - - - - - - - org.apache.maven.plugins - - - maven-dependency-plugin - - [2.8,) - - copy - - - - - - - - - - - - - + + + + . + + resources/configuration.properties + + true + + + + + maven-resources-plugin + 2.6 + + + copy-ant-resources-to-tools-zip + generate-sources + + copy-resources + + + ${tools-zip} + + + src/main/resources/tools-zip + + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + 2.8 + - - - - - - edu.wpi.first.wpilib - RobotBuilder - 2.0.0-SNAPSHOT - - - edu.wpi.first.wpilib - SmartDashboard - 1.0.0-SNAPSHOT - - - edu.wpi.first.wpilib - sfx - zip - LATEST - - - edu.wpi.first.wpilib.networktables - OutlineViewer - 1.0.0-SNAPSHOT - - + + + fetch-jar-zip-dependencies + compile + + copy + + + + + edu.wpi.first.wpilib + RobotBuilder + 2.0.0-SNAPSHOT + ${tools-zip} + RobotBuilder.jar + + + edu.wpi.first.wpilib + SmartDashboard + 1.0.0-SNAPSHOT + ${tools-zip} + SmartDashboard.jar + + + edu.wpi.first.wpilib + sfx + zip + zip + ${tools-zip}/../ + sfx.zip + + + edu.wpi.first.wpilib.networktables + OutlineViewer + 1.0.0-SNAPSHOT + ${tools-zip} + OutlineViewer.jar + + + edu.wpi.first.wpilib + java-installer + 1.0-SNAPSHOT + ${tools-zip} + java-installer.jar + + + + false + true + + + + + + org.apache.maven.plugins + maven-antrun-plugin + 1.7 + + + + + set-version-info + + run + + process-sources + + + + + + + + + + + true + + + + + + generate-jar-zip + compile + + run + + + + + + + + + + + + + + + + org.eclipse.m2e + lifecycle-mapping + 1.0.0 + + + + + + + org.apache.maven.plugins + + + maven-dependency-plugin + + [2.8,) + + copy + + + + + + + + + + + + + + + + + + + + edu.wpi.first.wpilib + RobotBuilder + 2.0.0-SNAPSHOT + + + edu.wpi.first.wpilib + SmartDashboard + 1.0.0-SNAPSHOT + + + edu.wpi.first.wpilib + sfx + zip + LATEST + + + edu.wpi.first.wpilib.networktables + OutlineViewer + 1.0.0-SNAPSHOT + + diff --git a/eclipse-plugins/edu.wpi.first.wpilib.plugins.cpp.feature/pom.xml b/eclipse-plugins/edu.wpi.first.wpilib.plugins.cpp.feature/pom.xml index d4a9b0d738..ad3d876540 100644 --- a/eclipse-plugins/edu.wpi.first.wpilib.plugins.cpp.feature/pom.xml +++ b/eclipse-plugins/edu.wpi.first.wpilib.plugins.cpp.feature/pom.xml @@ -1,15 +1,16 @@ - - 4.0.0 - edu.wpi.first.wpilib.plugins.cpp.feature - eclipse-feature + + 4.0.0 + edu.wpi.first.wpilib.plugins.cpp.feature + eclipse-feature - - edu.wpi.first.wpilib.plugins - edu.wpi.first.wpilib.plugins - 0.1.0.qualifier - .. - + + edu.wpi.first.wpilib.plugins + edu.wpi.first.wpilib.plugins + 0.1.0.qualifier + .. + diff --git a/eclipse-plugins/edu.wpi.first.wpilib.plugins.cpp/pom.xml b/eclipse-plugins/edu.wpi.first.wpilib.plugins.cpp/pom.xml index 981292b3e1..a11a566e1e 100644 --- a/eclipse-plugins/edu.wpi.first.wpilib.plugins.cpp/pom.xml +++ b/eclipse-plugins/edu.wpi.first.wpilib.plugins.cpp/pom.xml @@ -1,210 +1,212 @@ - - 4.0.0 - edu.wpi.first.wpilib.plugins.cpp - eclipse-plugin - - edu.wpi.first.wpilib.plugins - edu.wpi.first.wpilib.plugins - 0.1.0.qualifier - .. - - - DEVELOPMENT - ${project.build.directory}/cpp-zip - - - - - . - - resources/configuration.properties - - true - - - - - maven-resources-plugin - 2.6 - - - copy-ant-resources-to-cpp-zip - generate-sources - - copy-resources - - - ${cpp-zip} - - - src/main/resources/cpp-zip - - - - - - - - org.apache.maven.plugins - maven-dependency-plugin - 2.8 - - - - fetch-cpp-zip-dependencies - compile - - copy - - - - - edu.wpi.first.wpilib.cmake - cpp-root - 1.0.0 - zip - cpp-root.jar - - - edu.wpi.first.wpilibc.simulation - WPILibCSim - 0.1.0 - zip - sim-include.zip - - - ${project.build.directory} - false - true - true - - - + + 4.0.0 + edu.wpi.first.wpilib.plugins.cpp + eclipse-plugin + + edu.wpi.first.wpilib.plugins + edu.wpi.first.wpilib.plugins + 0.1.0.qualifier + .. + + + DEVELOPMENT + ${project.build.directory}/cpp-zip + + + + + . + + resources/configuration.properties + + true + + + + + maven-resources-plugin + 2.6 + + + copy-ant-resources-to-cpp-zip + generate-sources + + copy-resources + + + ${cpp-zip} + + + src/main/resources/cpp-zip + + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + 2.8 + + + + fetch-cpp-zip-dependencies + compile + + copy + + + + + edu.wpi.first.wpilib.cmake + cpp-root + 1.0.0 + zip + cpp-root.jar + + + edu.wpi.first.wpilibc.simulation + WPILibCSim + 0.1.0 + zip + sim-include.zip + + + ${project.build.directory} + false + true + true + + + - fetch-sim-jar-zip-dependencies - compile - - copy - - - ${cpp-zip}/sim/lib - false - true - - - - net.java.jinput - jinput-platform - 2.0.5 - natives-linux - jar - + fetch-sim-jar-zip-dependencies + compile + + copy + + + ${cpp-zip}/sim/lib + false + true - - edu.wpi.first.wpilibj.simulation - SimDS - 0.1.0-SNAPSHOT - SimDS.jar - ${cpp-zip}/sim/tools - - - + + + net.java.jinput + jinput-platform + 2.0.5 + natives-linux + jar + + + + edu.wpi.first.wpilibj.simulation + SimDS + 0.1.0-SNAPSHOT + SimDS.jar + ${cpp-zip}/sim/tools + + + + + + + + org.apache.maven.plugins + maven-antrun-plugin + 1.7 + + + + + set-version-info + + run + + process-sources + + + + + + + + + + + true + + + + + + unzip-cpp-includes + compile + + run + + + + + + + + + + + - - - - org.apache.maven.plugins - maven-antrun-plugin - 1.7 - - - - - set-version-info - - run - - process-sources - - - - - - - - - - - true - - - - - - unzip-cpp-includes - compile - - run - - - - - - - - - - - - - - unzip-jinput-libs - compile - - run - - - - - - - - - - - generate-cpp-zip - compile - - run - - - - - - - - - - - - - - edu.wpi.first.wpilib.cmake - cpp-root - 1.0.0 - zip - - - edu.wpi.first.wpilibc.simulation - WPILibCSim - 0.1.0 - zip - - + + unzip-jinput-libs + compile + + run + + + + + + + + + + + generate-cpp-zip + compile + + run + + + + + + + + + + + + + + edu.wpi.first.wpilib.cmake + cpp-root + 1.0.0 + zip + + + edu.wpi.first.wpilibc.simulation + WPILibCSim + 0.1.0 + zip + + diff --git a/eclipse-plugins/edu.wpi.first.wpilib.plugins.java.feature/pom.xml b/eclipse-plugins/edu.wpi.first.wpilib.plugins.java.feature/pom.xml index 5abf065c41..5d259ac0dd 100644 --- a/eclipse-plugins/edu.wpi.first.wpilib.plugins.java.feature/pom.xml +++ b/eclipse-plugins/edu.wpi.first.wpilib.plugins.java.feature/pom.xml @@ -1,15 +1,16 @@ - - 4.0.0 - edu.wpi.first.wpilib.plugins.java.feature - eclipse-feature + + 4.0.0 + edu.wpi.first.wpilib.plugins.java.feature + eclipse-feature - - edu.wpi.first.wpilib.plugins - edu.wpi.first.wpilib.plugins - 0.1.0.qualifier - .. - + + edu.wpi.first.wpilib.plugins + edu.wpi.first.wpilib.plugins + 0.1.0.qualifier + .. + diff --git a/eclipse-plugins/edu.wpi.first.wpilib.plugins.java/pom.xml b/eclipse-plugins/edu.wpi.first.wpilib.plugins.java/pom.xml index 2c6650ca60..a9b5d19925 100644 --- a/eclipse-plugins/edu.wpi.first.wpilib.plugins.java/pom.xml +++ b/eclipse-plugins/edu.wpi.first.wpilib.plugins.java/pom.xml @@ -1,383 +1,378 @@ - - 4.0.0 - edu.wpi.first.wpilib.plugins.java - eclipse-plugin + + 4.0.0 + edu.wpi.first.wpilib.plugins.java + eclipse-plugin - - edu.wpi.first.wpilib.plugins - edu.wpi.first.wpilib.plugins - 0.1.0.qualifier - .. - + + edu.wpi.first.wpilib.plugins + edu.wpi.first.wpilib.plugins + 0.1.0.qualifier + .. + - - DEVELOPMENT - ${project.build.directory}/java-zip - + + DEVELOPMENT + ${project.build.directory}/java-zip + - - - - . - - resources/configuration.properties - - true - - - - - maven-resources-plugin - 2.6 - - - copy-ant-resources-to-java-zip - generate-sources - - copy-resources - - - ${java-zip} - - - src/main/resources/java-zip - - - - - - - - org.apache.maven.plugins - maven-dependency-plugin - 2.8 - - - - - fetch-jar-zip-dependencies - compile - - copy - - - - - - edu.wpi.first.wpilib.networktables.java - NetworkTables - 0.1.0-SNAPSHOT - jar - NetworkTables.jar - ${java-zip}/lib - - - edu.wpi.first.wpilibj - wpilibJavaFinal - 0.1.0-SNAPSHOT - jar - WPILib.jar - ${java-zip}/lib - - - - edu.wpi.first.wpilib.networktables.java - NetworkTables - 0.1.0-SNAPSHOT - sources - ${java-zip}/lib - NetworkTables-sources.jar - - - edu.wpi.first.wpilibj - wpilibJavaFinal - 0.1.0-SNAPSHOT - sources - ${java-zip}/lib - WPILib-sources.jar - + + + + . + + resources/configuration.properties + + true + + + + + maven-resources-plugin + 2.6 + + + copy-ant-resources-to-java-zip + generate-sources + + copy-resources + + + ${java-zip} + + + src/main/resources/java-zip + + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + 2.8 + - - - edu.wpi.first.wpilibj - wpilibJavaFinal - 0.1.0-SNAPSHOT - javadoc - ${java-zip}/javadoc-jar - - - - false - true - - + + + fetch-jar-zip-dependencies + compile + + copy + + + + + + edu.wpi.first.wpilib.networktables.java + NetworkTables + 0.1.0-SNAPSHOT + jar + NetworkTables.jar + ${java-zip}/lib + + + edu.wpi.first.wpilibj + wpilibJavaFinal + 0.1.0-SNAPSHOT + jar + WPILib.jar + ${java-zip}/lib + + + + edu.wpi.first.wpilib.networktables.java + NetworkTables + 0.1.0-SNAPSHOT + sources + ${java-zip}/lib + NetworkTables-sources.jar + + + edu.wpi.first.wpilibj + wpilibJavaFinal + 0.1.0-SNAPSHOT + sources + ${java-zip}/lib + WPILib-sources.jar + - - - fetch-sim-jar-zip-dependencies - compile - - copy - - - ${java-zip}/sim/lib - false - true - - - - org.gazebosim - JavaGazebo - 0.1.0-SNAPSHOT - - - edu.wpi.first.wpilibj - wpilibJava - 0.1.0-SNAPSHOT - jar - - - edu.wpi.first.wpilibj - wpilibJavaSim - 0.1.0-SNAPSHOT - jar - - - edu.wpi.first.wpilib.networktables.java - NetworkTables - 0.1.0-SNAPSHOT - - - - net.java.jinput - jinput - 2.0.5 - - - net.java.jinput - jinput-platform - 2.0.5 - natives-linux + + + edu.wpi.first.wpilibj + wpilibJavaFinal + 0.1.0-SNAPSHOT + javadoc + ${java-zip}/javadoc-jar + + + + false + true + + + + + + fetch-sim-jar-zip-dependencies + compile + + copy + + + ${java-zip}/sim/lib + false + true + + + + org.gazebosim + JavaGazebo + 0.1.0-SNAPSHOT + + + edu.wpi.first.wpilibj + wpilibJavaSim + 0.1.0-SNAPSHOT + jar + + + edu.wpi.first.wpilib.networktables.java + NetworkTables + 0.1.0-SNAPSHOT + + + + net.java.jinput + jinput + 2.0.5 + + + net.java.jinput + jinput-platform + 2.0.5 + natives-linux + jar + + + net.java.jutils + jutils + 1.0.0 + + + + com.google.protobuf + protobuf-java + 2.5.0 + + + + edu.wpi.first.wpilibj.simulation + SimDS + 0.1.0-SNAPSHOT + SimDS.jar + ${java-zip}/sim/tools + + + + + + + + org.apache.maven.plugins + maven-antrun-plugin + 1.7 + + + + + set-version-info + + run + + process-sources + + + + + + + + + + + true + + + + + + unzip-javadocs + compile + + run + + + + + + + + + + + + + + + + unzip-jinput-libs + compile + + run + + + + + + + + + + + generate-jar-zip + compile + + run + + + + + + + + + + + + + + + org.eclipse.m2e + lifecycle-mapping + 1.0.0 + + + + + + + org.apache.maven.plugins + + + maven-dependency-plugin + + [2.8,) + + copy + + + + + + + + + + + + + + + + + + + edu.wpi.first.wpilib.networktables.java + NetworkTables + 0.1.0-SNAPSHOT + jar + + + edu.wpi.first.wpilibj + wpilibJavaFinal + 0.1.0-SNAPSHOT + jar + + + edu.wpi.first.wpilibj + wpilibJavaSim + 0.1.0-SNAPSHOT + jar + + + edu.wpi.first.wpilibj + wpilibJavaFinal + 0.1.0-SNAPSHOT + sources + + + - - com.google.protobuf - protobuf-java - 2.5.0 - + + + edu.wpi.first.wpilib.networktables.java + NetworkTables + 0.1.0-SNAPSHOT + sources + + + + + + + + + + + - - edu.wpi.first.wpilibj.simulation - SimDS - 0.1.0-SNAPSHOT - SimDS.jar - ${java-zip}/sim/tools - - - - - - - - org.apache.maven.plugins - maven-antrun-plugin - 1.7 - - - - - set-version-info - - run - - process-sources - - - - - - - - - - - true - - - - - - unzip-javadocs - compile - - run - - - - - - - - - - - - - - - - unzip-jinput-libs - compile - - run - - - - - - - - - - - generate-jar-zip - compile - - run - - - - - - - - - - - - - - - org.eclipse.m2e - lifecycle-mapping - 1.0.0 - - - - - - - org.apache.maven.plugins - - - maven-dependency-plugin - - [2.8,) - - copy - - - - - - - - - - - - - - - - - - - edu.wpi.first.wpilib.networktables.java - NetworkTables - 0.1.0-SNAPSHOT - jar - - - edu.wpi.first.wpilibj - wpilibJavaFinal - 0.1.0-SNAPSHOT - jar - - - edu.wpi.first.wpilibj - wpilibJavaSim - 0.1.0-SNAPSHOT - jar - - - edu.wpi.first.wpilibj - wpilibJavaFinal - 0.1.0-SNAPSHOT - sources - - - - - - - edu.wpi.first.wpilib.networktables.java - NetworkTables - 0.1.0-SNAPSHOT - sources - - - edu.wpi.first.wpilibj - wpilibJava - 0.1.0-SNAPSHOT - - - edu.wpi.first.wpilibj - wpilibJavaDevices - 0.1.0-SNAPSHOT - - - - - edu.wpi.first.wpilibj - wpilibJava - 0.1.0-SNAPSHOT - javadoc - - - edu.wpi.first.wpilibj - wpilibJavaDevices - 0.1.0-SNAPSHOT - javadoc - - + + + + + + + + + + + + + + diff --git a/eclipse-plugins/edu.wpi.first.wpilib.plugins.riolog/pom.xml b/eclipse-plugins/edu.wpi.first.wpilib.plugins.riolog/pom.xml index e246bd30e2..75dffb853c 100644 --- a/eclipse-plugins/edu.wpi.first.wpilib.plugins.riolog/pom.xml +++ b/eclipse-plugins/edu.wpi.first.wpilib.plugins.riolog/pom.xml @@ -1,15 +1,16 @@ - - 4.0.0 - edu.wpi.first.wpilib.plugins.riolog - eclipse-plugin + + 4.0.0 + edu.wpi.first.wpilib.plugins.riolog + eclipse-plugin - - edu.wpi.first.wpilib.plugins - edu.wpi.first.wpilib.plugins - 0.1.0.qualifier - .. - + + edu.wpi.first.wpilib.plugins + edu.wpi.first.wpilib.plugins + 0.1.0.qualifier + .. + diff --git a/eclipse-plugins/edu.wpi.first.wpilib.plugins.updatesite/pom.xml b/eclipse-plugins/edu.wpi.first.wpilib.plugins.updatesite/pom.xml index 612dd10319..8c1f3a81f4 100644 --- a/eclipse-plugins/edu.wpi.first.wpilib.plugins.updatesite/pom.xml +++ b/eclipse-plugins/edu.wpi.first.wpilib.plugins.updatesite/pom.xml @@ -1,14 +1,15 @@ - - 4.0.0 - edu.wpi.first.wpilib.plugins.updatesite - eclipse-update-site + + 4.0.0 + edu.wpi.first.wpilib.plugins.updatesite + eclipse-update-site - - edu.wpi.first.wpilib.plugins - edu.wpi.first.wpilib.plugins - 0.1.0.qualifier - .. - + + edu.wpi.first.wpilib.plugins + edu.wpi.first.wpilib.plugins + 0.1.0.qualifier + .. + diff --git a/eclipse-plugins/pom.xml b/eclipse-plugins/pom.xml index ddd3a50d8a..fe3ab7034e 100644 --- a/eclipse-plugins/pom.xml +++ b/eclipse-plugins/pom.xml @@ -1,98 +1,99 @@ - - 4.0.0 - edu.wpi.first.wpilib.plugins - edu.wpi.first.wpilib.plugins - 0.1.0.qualifier - pom + + 4.0.0 + edu.wpi.first.wpilib.plugins + edu.wpi.first.wpilib.plugins + 0.1.0.qualifier + pom - - edu.wpi.first.wpilib.plugins.core - edu.wpi.first.wpilib.plugins.core.feature - edu.wpi.first.wpilib.plugins.cpp - edu.wpi.first.wpilib.plugins.cpp.feature - edu.wpi.first.wpilib.plugins.java - edu.wpi.first.wpilib.plugins.java.feature - edu.wpi.first.wpilib.plugins.riolog - edu.wpi.first.wpilib.plugins.updatesite - - - - - 0.21.0 - + + edu.wpi.first.wpilib.plugins.core + edu.wpi.first.wpilib.plugins.core.feature + edu.wpi.first.wpilib.plugins.cpp + edu.wpi.first.wpilib.plugins.cpp.feature + edu.wpi.first.wpilib.plugins.java + edu.wpi.first.wpilib.plugins.java.feature + edu.wpi.first.wpilib.plugins.riolog + edu.wpi.first.wpilib.plugins.updatesite + - - - juno - p2 - http://download.eclipse.org/releases/luna - - - FRC Binaries - http://first.wpi.edu/FRC/c/maven/ - - - - - - - org.eclipse.tycho - tycho-maven-plugin - ${tycho-version} - true - - - + + + 0.21.0 + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - docline-java8-disable - - [1.8, - + + + juno + p2 + http://download.eclipse.org/releases/luna + + + FRC Binaries + http://first.wpi.edu/FRC/c/maven/ + + - - - - org.apache.maven.plugins - maven-javadoc-plugin - - -Xdoclint:none - - - - - + + + + org.eclipse.tycho + tycho-maven-plugin + ${tycho-version} + true + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + docline-java8-disable + + [1.8, + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + + -Xdoclint:none + + + + + + + diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000..085a1cdc27 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000..519981e3c5 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Tue May 05 10:43:11 EDT 2015 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-2.4-all.zip diff --git a/gradlew b/gradlew new file mode 100755 index 0000000000..91a7e269e1 --- /dev/null +++ b/gradlew @@ -0,0 +1,164 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; +esac + +# For Cygwin, ensure paths are in UNIX format before anything is touched. +if $cygwin ; then + [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` +fi + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >&- +APP_HOME="`pwd -P`" +cd "$SAVED" >&- + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000000..8a0b282aa6 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,90 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windowz variants + +if not "%OS%" == "Windows_NT" goto win9xME_args +if "%@eval[2+2]" == "4" goto 4NT_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* +goto execute + +:4NT_args +@rem Get arguments from the 4NT Shell from JP Software +set CMD_LINE_ARGS=%$ + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/hal/build.gradle b/hal/build.gradle new file mode 100644 index 0000000000..9c5642cf39 --- /dev/null +++ b/hal/build.gradle @@ -0,0 +1,23 @@ +apply plugin: 'cpp' + +model { + components { + HALAthena(NativeLibrarySpec) { + targetPlatform 'arm' + tasks.withType(CppCompile) { + dependsOn addNiLibraryLinks + } + sources { + cpp { + source { + srcDirs = ["lib/Athena", "lib/Athena/FRC_FPGA_ChipObject"] + includes = ["**/*.cpp"] + } + exportedHeaders { + srcDirs = ["include", "lib/Athena", "lib/Athena/FRC_FPGA_ChipObject"] + } + } + } + } + } +} diff --git a/jenkins/build.gradle b/jenkins/build.gradle new file mode 100644 index 0000000000..419c05922a --- /dev/null +++ b/jenkins/build.gradle @@ -0,0 +1,31 @@ +evaluationDependsOn(':wpilibj') +evaluationDependsOn(':wpilibc') + +task publishJavadoc(type: Copy) { + description = 'Publishes the generated javadoc to the docs/site/java folder' + group = 'WPILib' + def javadoc = project(':wpilibj').javadoc + dependsOn javadoc + from javadoc.destinationDir + destinationDir file('docs/site/java') +} + +task publishDoxygen(type: Copy) { + description = 'Publishes the generated doxygen to the docs/site/cpp folder' + group = 'WPILib' + def doxygen = project(':wpilibc').doxygen + dependsOn doxygen + from doxygen.outputDir + destinationDir file('docs/site/cpp') +} + +task publishDocs() { + description = 'Publishes the generated javadoc and doxygen to the docs/site/ folder' + group = 'WPILib' + dependsOn publishJavadoc + dependsOn publishDoxygen +} + +task clean(type: Delete) { + delete 'docs/site' +} diff --git a/networktables/OutlineViewer/build.gradle b/networktables/OutlineViewer/build.gradle index dcf951eae2..6bcbe75891 100644 --- a/networktables/OutlineViewer/build.gradle +++ b/networktables/OutlineViewer/build.gradle @@ -1,24 +1,39 @@ apply plugin: 'java' -apply plugin: 'maven' +apply plugin: 'application' +apply plugin: 'com.github.johnrengelman.shadow' +apply plugin: 'maven-publish' -group = "edu.wpi.frc.wpilib" -version = "2.0" - -sourceCompatibility = 1.7 - -sourceSets { - main { - java { - srcDirs = ["src"] - } - } +buildscript { + repositories { jcenter() } + dependencies { + classpath 'com.github.jengelman.gradle.plugins:shadow:1.2.1' + } } -repositories { - mavenCentral() - mavenLocal() +mainClassName = 'edu.wpi.first.tableviewer.TableViewer' + +publishing { + publications { + maven(MavenPublication) { + artifact(shadowJar) { + classifier null + } + groupId 'edu.wpi.first.wpilib.networktables' + artifactId 'OutlineViewer' + version '1.0.0-SNAPSHOT' + } + } +} + +sourceSets { + main { + java { + srcDirs = ["src"] + } + } } dependencies { - compile project(":java") + compile project(":networktables:java") + compile 'uk.gov.nationalarchives.thirdparty.netbeans:org-netbeans-swing-outline:7.2' } diff --git a/networktables/cpp/build.gradle b/networktables/cpp/build.gradle index 4476593660..64e3e2e457 100644 --- a/networktables/cpp/build.gradle +++ b/networktables/cpp/build.gradle @@ -1,19 +1,21 @@ apply plugin: 'cpp' -libraries { - main {} +model { + components { + NetworkTables(NativeLibrarySpec) { + targetPlatform 'arm' + sources { + cpp { + source { + srcDirs = ["lib/share", "lib/Athena"] + includes = ["**/*.cpp"] + } + exportedHeaders { + srcDirs = ["include"] + } + } + } + } + } } -sources { - main { - cpp { - source { - srcDirs = ["lib/share", "lib/Athena"] - // includes = "**/*.cpp" - } - exportedHeaders { - srcDirs = ["include"] - } - } - } -} \ No newline at end of file diff --git a/networktables/java/build.gradle b/networktables/java/build.gradle index 5cacc13e6e..4b1170cd0a 100644 --- a/networktables/java/build.gradle +++ b/networktables/java/build.gradle @@ -1,39 +1,68 @@ apply plugin: 'java' -apply plugin: 'maven' +apply plugin: 'maven-publish' group = "edu.wpi.frc.wpilib" version = "2.0" +archivesBaseName = 'NetworkTables' + +publishing { + publications { + maven(MavenPublication) { + from components.java + artifact (networktablesSource) { + classifier = 'sources' + } + artifact (networktablesJavadoc) { + classifier = 'javadoc' + } + + groupId 'edu.wpi.first.wpilib.networktables.java' + artifactId 'NetworkTables' + version '0.1.0-SNAPSHOT' + } + } + repositories { + maven { + url "file://${System.properties['user.home']}/releases/maven" + } + } +} sourceSets { - main { - java { - srcDirs = ["src/main/java", "Athena/src/main/java"] - } - } - test { - java { - srcDirs = ["Athena/src/test/java"] - excludes = ["edu/wpi/first/wpilibj/networktables2/system/SystemTest.java"] - } - } + main { + java { + srcDirs = ["src/main/java", "Athena/src/main/java"] + } + } + test { + java { + srcDirs = ["src/test/java"] + excludes = ["edu/wpi/first/wpilibj/networktables2/system/SystemTest.java"] + } + } +} + +task networktablesSource(type: Jar, dependsOn: classes) { + description = 'Generates the source jar for NetworktTables java' + group = 'WPILib' + classifier = 'classes' + from sourceSets.main.allJava +} + +task networktablesJavadoc(type: Jar, dependsOn: javadoc) { + description = 'Generates the javadoc jar for NetworkTables java' + group = 'WPILib' + classifier = 'javadoc' + from javadoc.destinationDir } repositories { - mavenCentral() - mavenLocal() + mavenCentral() } dependencies { - testCompile group: 'junit', name: 'junit', version: '4.+' - testCompile group: 'org.jmock', name: 'jmock-junit4', version: '2.6.0' - testCompile group: 'org.jmock', name: 'jmock-legacy', version: '2.6.0' + testCompile group: 'junit', name: 'junit', version: '4.+' + testCompile group: 'org.jmock', name: 'jmock-junit4', version: '2.6.0' + testCompile group: 'org.jmock', name: 'jmock-legacy', version: '2.6.0' } -uploadArchives { - repositories { - mavenDeployer { - repository(url: "file://localhost/tmp/myRepo/") - pom.artifactId = 'networktables' - } - } -} diff --git a/networktables/settings.gradle b/networktables/settings.gradle deleted file mode 100644 index 9ae3de8100..0000000000 --- a/networktables/settings.gradle +++ /dev/null @@ -1 +0,0 @@ -include "java", "java-table-viewer" \ No newline at end of file diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000000..0b8394c4a3 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,10 @@ +include 'networktables:java', + 'networktables:cpp', + 'networktables:OutlineViewer', + 'hal', + 'wpilibj', + 'wpilibc', + 'simulation:JavaGazebo', + 'simulation:SimDS', + 'jenkins', + 'driver-station' \ No newline at end of file diff --git a/simulation/JavaGazebo/build.gradle b/simulation/JavaGazebo/build.gradle new file mode 100644 index 0000000000..8606485b18 --- /dev/null +++ b/simulation/JavaGazebo/build.gradle @@ -0,0 +1,17 @@ +apply plugin: 'java' +apply plugin: 'maven-publish' + +publishing { + publications { + maven(MavenPublication) { + artifact jar + groupId 'org.gazebosim' + artifactId 'JavaGazebo' + version '0.1.0-SNAPSHOT' + } + } +} + +dependencies { + compile 'com.google.protobuf:protobuf-java:2.5.0' +} \ No newline at end of file diff --git a/simulation/SimDS/build.gradle b/simulation/SimDS/build.gradle new file mode 100644 index 0000000000..89926abd6f --- /dev/null +++ b/simulation/SimDS/build.gradle @@ -0,0 +1,53 @@ +apply plugin: 'java' +apply plugin: 'application' +apply plugin: 'com.github.johnrengelman.shadow' +apply plugin: 'maven-publish' + +// Adds the dependency for the shadow plugin, which creates an uberjar with all dependencies +buildscript { + repositories { jcenter() } + dependencies { + classpath 'com.github.jengelman.gradle.plugins:shadow:1.2.1' + } +} + +publishing { + publications { + maven(MavenPublication) { + artifact(shadowJar) { + // The shadow plugin has the 'all' classifier. We don't want this, so use null instead + classifier null + } + artifact(simDsSources) { + classifier 'sources' + } + artifact(simDsJavadoc) { + classifier 'javadoc' + } + groupId 'edu.wpi.first.wpilibj.simulation' + artifactId 'SimDS' + version '0.1.0-SNAPSHOT' + } + } +} + +mainClassName = 'edu.wpi.first.wpilibj.simulation.ds.Main' + +dependencies { + compile 'net.java.jinput:jinput:2.0.5' + compile project(':simulation:JavaGazebo') +} + +task simDsSources(type: Jar, dependsOn: classes) { + description = 'Creates the sources jar for the SimDS' + group = 'WPILib' + classifier = 'sources' + from sourceSets.main.allJava +} + +task simDsJavadoc(type: Jar, dependsOn: javadoc) { + description = 'Creates the javadoc jar for the SimDS' + group = 'WPILib' + classifier = 'javadoc' + from javadoc.destinationDir +} \ No newline at end of file diff --git a/test-scripts/config.sh b/test-scripts/config.sh index 522870dd4f..78b327f610 100755 --- a/test-scripts/config.sh +++ b/test-scripts/config.sh @@ -10,7 +10,6 @@ # so that test results are not commited to the repo DEFAULT_LOCAL_TEST_RESULTS_DIR=../test-reports - ROBOT_ADDRESS=admin@roboRIO-190.local DEFAULT_LOCAL_RUN_TEST_SCRIPT="run-tests-on-robot.sh" @@ -21,7 +20,12 @@ DEFAULT_DESTINATION_TEST_RESULTS_DIR=${DEFAULT_DESTINATION_DIR}/testResults # C++ test variables DEFAULT_CPP_TEST_NAME=FRCUserProgram DEFAULT_CPP_TEST_ARGS="--gtest_color=yes" -DEFAULT_LOCAL_CPP_TEST_FILE=../cmake/target/cmake/wpilibc/wpilibC++IntegrationTests/FRCUserProgram +if [ "$GRADLE" ]; then + DEFAULT_LOCAL_CPP_TEST_FILE=../wpilibc/build/binaries/fRCUserProgramExecutable/FRCUserProgram +else + DEFAULT_LOCAL_CPP_TEST_FILE=../cmake/target/cmake/wpilibc/wpilibC++IntegrationTests/FRCUserProgram +fi + CPP_REPORT=cppreport.xml DEFAULT_LOCAL_CPP_TEST_RESULT=${DEFAULT_LOCAL_TEST_RESULTS_DIR}/${CPP_REPORT} DEFAULT_DESTINATION_CPP_TEST_RESULTS=${DEFAULT_DESTINATION_TEST_RESULTS_DIR}/${CPP_REPORT} @@ -29,7 +33,13 @@ DEFAULT_DESTINATION_CPP_TEST_RESULTS=${DEFAULT_DESTINATION_TEST_RESULTS_DIR}/${C # Java test variables DEFAULT_JAVA_TEST_NAME=FRCUserProgram.jar DEFAULT_JAVA_TEST_ARGS="" -DEFAULT_LOCAL_JAVA_TEST_FILE=../wpilibj/wpilibJavaIntegrationTests/target/wpilibJavaIntegrationTests-0.1.0-SNAPSHOT.jar + +if [ "$GRADLE" ]; then + DEFAULT_LOCAL_JAVA_TEST_FILE=../wpilibj/build/libs/wpilibJavaIntegrationTests-0.1.0-SNAPSHOT.jar +else + DEFAULT_LOCAL_JAVA_TEST_FILE=../wpilibj/wpilibJavaIntegrationTests/target/wpilibJavaIntegrationTests-0.1.0-SNAPSHOT.jar +fi + JAVA_REPORT=javareport.xml DEFAULT_LOCAL_JAVA_TEST_RESULT=${DEFAULT_LOCAL_TEST_RESULTS_DIR}/${JAVA_REPORT} DEFAULT_DESTINATION_JAVA_TEST_RESULTS=${DEFAULT_DESTINATION_TEST_RESULTS_DIR}/AntReports/TEST-edu.wpi.first.wpilibj.test.TestSuite.xml diff --git a/wpilibc/build.gradle b/wpilibc/build.gradle new file mode 100644 index 0000000000..ef289c403a --- /dev/null +++ b/wpilibc/build.gradle @@ -0,0 +1,233 @@ +apply plugin: 'cpp' +apply plugin: 'maven-publish' +apply plugin : 'org.ysb33r.doxygen' + +buildscript { + repositories { + jcenter() + } + dependencies { + classpath 'org.ysb33r.gradle:doxygen:0.2' + } +} + +def shared = 'wpilibC++' +def devices = 'wpilibC++Devices' +def sim = 'wpilibC++Sim' + +// Ensure that both hal and networktables are evaluated, so that they have the binaries property. We need this to +// properly copy their archives into the final zip +evaluationDependsOn(':hal') +evaluationDependsOn(':networktables:cpp') + +publishing { + publications { + maven(MavenPublication) { + artifact wpilibcZip + groupId 'edu.wpi.first.wpilib.cmake' + artifactId 'cpp-root' + version '1.0.0' + } + mavenSim(MavenPublication) { + artifact wpilibcSimZip + groupId 'edu.wpi.first.wpilibc.simulation' + artifactId 'WPILibCSim' + version '0.1.0' + } + } +} + +model { + components { + wpilib_nonshared(NativeLibrarySpec) { + targetPlatform 'arm' + binaries.all { + tasks.withType(CppCompile) { + dependsOn addNiLibraryLinks + } + } + sources { + cpp { + source { + srcDirs = ["${shared}/src", "${devices}/src"] + includes = ['**/*.cpp'] + } + exportedHeaders { + srcDirs = ["${shared}/include", "${devices}/include"] + includes = ['**/*.h'] + } + lib project: ':hal', library: 'HALAthena', linkage: 'static' + lib project: ':networktables:cpp', library: 'NetworkTables', linkage: 'static' + } + } + } + FRCUserProgram(NativeExecutableSpec) { + targetPlatform 'arm' + binaries.all { + tasks.withType(CppCompile) { + dependsOn addNiLibraryLinks + } + + cppCompiler.args '-pthread' + linker.args '-pthread' + cppCompiler.args '-Wno-unused-variable' + linker.args '-Wno-unused-variable' + linker.args '-Wl,-rpath,/opt/GenICam_v2_3/bin/Linux_armv7-a' + } + sources { + cpp { + def dir = 'wpilibC++IntegrationTests' + source { + srcDir "${dir}/src" + include '*.cpp' + } + source { + srcDir "${dir}/src/gtest/src" + include 'gtest-all.cc', 'gtest_main.cc' + } + exportedHeaders { + srcDirs = ["${dir}/include", "${dir}/src/gtest", "${dir}/src/gtest/include", "${devices}/include", "${shared}/include", '../hal/include/HAL', '../networktables/cpp/include'] + include '**/*.h' + } + + lib library: 'wpilib_nonshared', linkage: 'static' + lib project: ':networktables:cpp', library: 'NetworkTables', linkage: 'static' + lib project: ':hal', library: 'HALAthena', linkage: 'static' + } + } + } + } +} + +doxygen { + source file("${shared}/src") + source file("${shared}/include") + source file("${devices}/src") + source file("${devices}/include") + def netTablesLoc = '../networktables/cpp' + source file("${netTablesLoc}/include") + source file("${netTablesLoc}/lib/Athena") + source file("${netTablesLoc}/lib/share") + template file('cpp.doxy') + exclude 'pcre.h' + exclude 'nivision.h' +} + +task wpilibcZip(type: Zip) { + description = 'Zips all of the libraries for wpilibc' + group = 'WPILib' + baseName = 'wpilibc' + destinationDir = project.buildDir + + // If doxygen is available on this computer, then include the output zip + if (checkDoxygen()) { + from(doxygen.outputDir) { + into 'docs' + } + } + + // Include the static library file and header files from this project + binaries.withType(StaticLibraryBinarySpec) { spec -> + spec.headerDirs.each { + from(it) { + into 'include' + } + } + from(spec.staticLibraryFile) { + into 'libs' + } + } + + // Include the static library file and header files from the networktables project + def netTables = project(':networktables:cpp') + netTables.binaries.withType(StaticLibraryBinarySpec) { spec -> + spec.headerDirs.each { + from(it) { + into 'include' + } + } + from(spec.staticLibraryFile) { + into 'libs' + } + } + + // Include the static library file and shared library object from hal project + def hal = project(':hal') + hal.binaries.withType(StaticLibraryBinarySpec) { spec -> + spec.headerDirs.each { + from(it) { + into 'include' + // We don't want to include any of the .cpp files that are in some of the header directories + exclude '**/*.cpp' + } + } + from(spec.staticLibraryFile) { + into 'libs' + } + } + hal.binaries.withType(SharedLibraryBinarySpec) { spec -> + from(spec.sharedLibraryFile) { + into 'libs' + } + } + + // We rename the libHALAthena.so object to libHALAthena_shared.so + rename('(libHALAthena)(.so)', '$1_shared$2') + + // Finally, include all of the shared library objects from the ni directory + from(project.file('../ni-libraries')) { + into 'libs' + exclude 'genlinks' + } +} + +task wpilibcSimZip(type: Zip) { + description 'Creates the include zip file for wpilibc' + group 'wpilib' + baseName 'WPILibCSim' + destinationDir = project.buildDir + into 'sim/include' + from "${sim}/include" + from "${shared}/include" + from '../networktables/cpp/include' + from '../hal/include' +} + +// Add the dependency on the wpilib_nonsharedStaticLibrary task to the wpilibc task. Because of the gradle lifecycle, +// this cannot be done purely with dependsOn in the task, as the static library task doesn't exist yet. Same goes for +// the networkTablesStaticLibrary task and the two HAL tasks below +tasks.whenTaskAdded { task -> + if (task.name == 'wpilib_nonsharedStaticLibrary') { + wpilibcZip.dependsOn task + } +} + +// Add the networktables static library as a dependency +project(':networktables:cpp').tasks.whenTaskAdded { task -> + if (task.name == 'networkTablesStaticLibrary') { + wpilibcZip.dependsOn task + } +} + +// Add the hal static and shared libraries as a dependency +project(':hal').tasks.whenTaskAdded { task -> + if (task.name == 'hALAthenaStaticLibrary' || task.name == 'hALAthenaSharedLibrary') { + wpilibcZip.dependsOn task + } +} + +// If doxygen exists on the command line, then add the doxygen task as dependency of the wpilibcZip task +if (checkDoxygen()) { + wpilibcZip.dependsOn doxygen +} + +// Attempts to execute the doxygen command. If there is no exception, doxygen exists, so return true. If there's +// an IOException, it doesn't exist, so return false +boolean checkDoxygen() { + try { + 'doxygen'.execute() + true + } catch (IOException e) { + false + } +} diff --git a/wpilibc/cpp.doxy b/wpilibc/cpp.doxy new file mode 100644 index 0000000000..7f861c37fb --- /dev/null +++ b/wpilibc/cpp.doxy @@ -0,0 +1,2303 @@ +# Doxyfile 1.8.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "WPILibC++" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 2015-Alpha-0.1 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = site/cpp + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# 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 respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# 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. Does not have any effect +# for Java sources. +# The default value is: YES. + +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 only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# 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. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO 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. +# The default value is: NO. + +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 these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +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 these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = YES + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = "doxygen.log" + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = build/cpp + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = nivision.h pcre.h */NetworkCommunication/* + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = . + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = YES + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /