Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
TULIP
TULIP
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 14
    • Issues 14
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 0
    • Merge Requests 0
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Analytics
    • Analytics
    • CI / CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • NUI
  • TULIPTULIP
  • Issues
  • #10

Closed
Open
Opened Apr 10, 2015 by Eric Tobias@etobias0 of 12 tasks completed0/12 tasks
  • Report abuse
  • New issue
Report abuse New issue

Complete documentation

Documentation should be completed with meaningful and stringent comments and Javadoc. This includes well chosen method and field names as well as parameters. Don't abbreviate where not necessary. Class names should not be redundant. "TuioConcreteAdapter" has both "Tuio" and "Concrete" in its name. One suffices.

Examples: Why call getObjectId() on TangibleObject? Is there another identifier than that of the object? Don't abbreviate object to obj in some cases.

  • TangibleObject
  • TangibleObjectBuilder
  • TuiAdapter
  • TuioConcreteAdapter
  • BluetoothClient
  • BluetoothServer
  • ClientAdapter
  • NetworkAdapter
  • ServerAdapter
  • TcpClient
  • TcpServer
  • XbeeAdapter

Same holds true for tests.

Assignee
Assign to
Integrate Nicola's work
Milestone
Integrate Nicola's work
Assign milestone
Time tracking
None
Due date
None
Reference: nui/tulip#10

Luxembourg Institute of Science and Technology - www.list.lu.