search

ftctechnh / ftc_app

FTC Android Studio project to create FTC Robot Controller app.
759 stars 3.17k forks source link

Documentation needs to be improved. #94

Open cn04 opened 8 years ago

cn04 commented 8 years ago

Currently the Javadoc descriptions for many of the classes in the API don't really provide much description; they're the same thing as the name of the class. Possibly it could be helpful to describe in more detail the functionality and use of each package and class.

dirthsj commented 8 years ago

I feel the same - documentation is very poor. I want a lot more of "When you do x, this happens" rather than "Is the motor busy?". How do I know what constitutes the motor being busy? At first glance, this might look like it's checking whether or not the motor is trying to move - which is useless, since we don't need a function to determine that. So what does it actually do? I don't know... I get 30 minutes before each competition to program our robot.

cn04 commented 8 years ago

Yes. Also, I noticed that it's unclear which type of hardware many of the classes in the robotcore 'hardware' package are referring to. Is the "LightSensor" an NXT or Modern Robotics light sensor? What kind of gyro sensor is the "GyroSensor"? HiTechnic? LEGO? and so on.

dirthsj commented 8 years ago

Well, I can tell you right now that those classes cover multiple sensors. The only sensor I know of that isn't supported is the LEGO Color Sensor (note: HiTechnic Color Sensor is supported). So using the LightSensor class will work on both LEGO and Modern Robotics light sensor AFAIK.

kk6axq commented 8 years ago

+1

KyleDavidE commented 8 years ago

+1

lukeboi commented 8 years ago

+1

thomaslauer commented 8 years ago

+1

Bendito999 commented 8 years ago

No more +1's please! It does not accomplish anything, and fills up everyone's inbox. Thank you.

strugee commented 8 years ago

@ftctechnh please consider locking this issue to prevent further +1s.