From 5cee85f921b96051bf5a9a23974fdc4b6d90374d Mon Sep 17 00:00:00 2001 From: Tyler Veness Date: Mon, 23 Nov 2015 00:35:34 -0800 Subject: [PATCH] Fixed some typos in the comments of MotorEncoderFixture.java, a method name in CANMotorEncoderFixture.java, and the README files Change-Id: I87d982068f3e7cdcce6e5b06c34a7ef326f5eae0 --- README.md | 4 ++-- simulation/README.md | 6 +++--- .../wpi/first/wpilibj/fixtures/CANMotorEncoderFixture.java | 4 ++-- .../edu/wpi/first/wpilibj/fixtures/MotorEncoderFixture.java | 4 ++-- .../src/main/java/edu/wpi/first/wpilibj/test/TestBench.java | 4 ++-- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c93b0a6bd4..567b9c5675 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ If you also want simulation to be build, add -PmakeSim. This requires gazebo_tra ``` C++ simulation tasks (including plugins, gz_msgs, and wpilibcSim) all depend on gazebo_transport. In order for this to build you must have installed gazebo. See [The Gazebo website](https://gazebosim.org/) for installation instructions. -If you prefer to use Cmake directly, the you can still do so. +If you prefer to use CMake directly, the you can still do so. The common cmake tasks are wpilibcSim, frc_gazebo_plugins, and gz_msgs ```bash @@ -62,7 +62,7 @@ The following maven targets a published by this task: - org.gazebosim:JavaGazebo:0.1.0-SNAPSHOT - Gazebo protocol for Java. ## Structure and Organization -The main wpilib code you're probably looking for is in wpilibj and wpilibc. Those directories are split into shared, sim, and athena. Athena contains the wpilib code meant to run on your RoboRIO. Sim is wpilib code meant to run on your computer with gazebo, and shared is code shared between the two. Shared code must be platform-independant, since it will be compiled with both the ARM cross-compiler and whatever desktop compiler you are using (g++, msvc, ect... ). +The main wpilib code you're probably looking for is in wpilibj and wpilibc. Those directories are split into shared, sim, and athena. Athena contains the wpilib code meant to run on your RoboRIO. Sim is wpilib code meant to run on your computer with gazebo, and shared is code shared between the two. Shared code must be platform-independent, since it will be compiled with both the ARM cross-compiler and whatever desktop compiler you are using (g++, msvc, etc...). The Simulation directory contains extra simulation tools and libraries, such as gz_msgs and JavaGazebo. See sub-directories for more information. diff --git a/simulation/README.md b/simulation/README.md index 75fdff0479..95c29e108f 100644 --- a/simulation/README.md +++ b/simulation/README.md @@ -1,6 +1,6 @@ ## Simulation Directory -Observe the following directory structure +Observe the following directory structure: . |-- frc_gazebo_plugins (contains Gazebo Plugins) @@ -21,7 +21,7 @@ Observe the following directory structure The gazbeo plugins are currently built with CMake. Eventually they will be built with gradle. -All of this is delivered to students via a zip file +All of this is delivered to students via a zip file. ## Building -see the top level building.md +See the top level README.md. diff --git a/wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/fixtures/CANMotorEncoderFixture.java b/wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/fixtures/CANMotorEncoderFixture.java index ae84bcfda8..99978c58fc 100644 --- a/wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/fixtures/CANMotorEncoderFixture.java +++ b/wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/fixtures/CANMotorEncoderFixture.java @@ -36,7 +36,7 @@ public abstract class CANMotorEncoderFixture extends MotorEncoderFixture + * on these different pairs
* Designed to allow the user to easily setup and tear down the fixture to allow * for reuse. This class should be explicitly instantiated in the TestBed class * to allow any test to access this fixture. This allows tests to be mailable so @@ -171,7 +171,7 @@ public abstract class MotorEncoderFixture implements /** * Safely tears down the MotorEncoder Fixture in a way that makes sure that - * even if an object fails to initialize the reset of the fixture can still be + * even if an object fails to initialize the rest of the fixture can still be * torn down and the resources deallocated */ @Override diff --git a/wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/test/TestBench.java b/wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/test/TestBench.java index 727c61bf5d..78a058ad07 100644 --- a/wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/test/TestBench.java +++ b/wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/test/TestBench.java @@ -218,11 +218,11 @@ public final class TestBench { * (non-Javadoc) *$ * @see - * edu.wpi.first.wpilibj.fixtures.CANMotorEncoderFixture#givePoweCycleRelay + * edu.wpi.first.wpilibj.fixtures.CANMotorEncoderFixture#givePowerCycleRelay * () */ @Override - protected Relay givePoweCycleRelay() { + protected Relay givePowerCycleRelay() { return new Relay(kCANRelayPowerCycler); }