Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Remaining documentation #97

Closed
81 tasks done
joeljfischer opened this issue Mar 9, 2015 · 0 comments
Closed
81 tasks done

Remaining documentation #97

joeljfischer opened this issue Mar 9, 2015 · 0 comments
Assignees
@joeljfischer @NicoleYarroch
Labels
documentation Relating to inline documentation
Milestone
6.0.0

Comments

@joeljfischer
Copy link
Contributor

joeljfischer commented Mar 9, 2015 •
edited by NicoleYarroch
Loading

#96 had lots of documentation, but lots is still missing as well. This is a constantly updated list of missing documentation, and should be checked off as new documentation is added.

(Incomplete, just starting off)

Requests

  • SDLAlertManeuver
  • SDLDiagnosticMessage
  • SDLEncodedSyncPData
  • SDLShowConstantTBT
  • SDLSyncPData
  • SDLSystemRequest

Responses
Basically all of them need some documentation, even if it's only an init method

Structs

  • SDLAirbagStatus
  • SDLBeltStatus
  • SDLClusterModeStatus
  • SDLDeviceInfo
  • SDLDIDResult
  • SDLECallInfo
  • SDLEmergencyEvent
  • SDLImageField
  • SDLImageResolution
  • SDLKeyboardProperties
  • SDLMyKey
  • SDLPermissionItem
  • SDLScreenParams
  • SDLSoftButton
  • SDLTireStatus
  • SDLTouchCoord
  • SDLTouchEvent (partial)
  • SDLTouchEventCapabilities
  • SDLTurn
  • SDLVehicleDataResult
  • SDLVRHelpItem

Enums

  • SDLAmbientLightStatus
  • SDLAppHMIType
  • SDLButtonName
  • SDLCharacterSet
  • SDLDisplayType
  • SDLGlobalProperty
  • SDLIgnitionStableStatus
  • SDLPowerModeQualificationStatus
  • SDLPowerModeStatus
  • SDLPredefinedLayout
  • SDLPrerecordedSpeech
  • SDLRequestType
  • SDLResult
  • SDLRPCMessageType
  • SDLSpeechCapabilities
  • SDLTBTState
  • SDLTextFieldName - MainField2, 3 are marked as SDL 2.0, 4 implicit as 1.0, is this correct?
  • SDLTimerMode
  • SDLTouchType

Notifications

  • SDLOnEncodedSyncPData
  • SDLOnHashChange
  • SDLOnKeyboardInput
  • SDLOnSyncPData
  • SDLOnSystemRequest
  • SDLOnTBTClientState
  • SDLTouchType
  • SDLOnVehicleData

Other

  • SDLJingle Removed
  • SDLConsoleController Removed
  • SDLDebugTool Removed
  • SDLSiphonServer Removed
  • SDLAbstractTransport Removed
  • SDLTransportDelegate
  • SDLIAPSessionDelegate
  • SDLIAPTransport
  • SDLTCPTransport
  • SDLEnum
  • SDLRPCStruct
  • SDLRPCMessage
  • SDLRPCNotification
  • SDLRPCRequest
  • SDLRPCResponse
  • SDLRPCRequestFactory Removed

Protocol

  • SDLAbstractProtocol Removed
  • SDLProtocol
  • SDLProtocolHeader
  • SDLProtocolListener
  • SDLProtocolMessage

Proxy

  • SDLProxyListener
  • SDLPolicyDataParser Removed
  • SDLProxy
  • SDLProxyFactory Removed
  • SDLTTSChunkFactory Removed
  • SDLStreamingMediaManager
@joeljfischer joeljfischer added the documentation Relating to inline documentation label Mar 9, 2015
@joeljfischer joeljfischer added this to the Future milestone Jul 31, 2015
@NicoleYarroch NicoleYarroch mentioned this issue Apr 9, 2018
Merged
9 tasks
@NicoleYarroch NicoleYarroch modified the milestones: Future, 6.0.0 May 24, 2018
@joeljfischer joeljfischer mentioned this issue May 25, 2018
Merged
2 tasks
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@joeljfischer joeljfischer

@NicoleYarroch NicoleYarroch

Labels
documentation Relating to inline documentation
Projects
None yet
Milestone
6.0.0
Development

No branches or pull requests
3 participants
@joeljfischer @justinjdickow @NicoleYarroch