Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Report on MOBILE_API.xml issues(missing description) #259

Open
Yuki-Shoda-Nexty opened this issue Jun 16, 2020 · 0 comments
Open

Report on MOBILE_API.xml issues(missing description) #259

Yuki-Shoda-Nexty opened this issue Jun 16, 2020 · 0 comments

Comments

@Yuki-Shoda-Nexty
Copy link

We propose correcting HMI_API.xml(missing description)

In current MOBILE_API.xml, some RPCs and parameters has no description.
By adding description for such RPCs and parameters, we can provide more accurate RPC documents for SDL developers.
The target items are described in the Excel file.

MOBILE_API_missing description.xlsx

e.g. Elements s of HMILevel in MOBILE_API.xml has no description. Add descriptions for each elements like below.

Add descriptions for each elements of HMILevel like below.

 <enum name="HMILevel" since="1.0">
     <description>Enumeration that describes current levels of HMI.</description>

     <element name="FULL" internal_name="HMI_FULL">
+        <description>
+            The application has full use of The SDL HMI. The app can output via TTS, display, or streaming audio and receive notifications via VR, Menu, and button presses.
+        </description>
     </element>
     <element name="LIMITED" internal_name="HMI_LIMITED" >
+        <description>
+            This HMI Level is only defined for a media application using an HMI with an 8 inch touchscreen(Navi) system.
+            The application can display text by "Show" and receives button presses from media-oriented buttons(SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN, PRESET_0-9).
+        </description>
     </element>
     <element name="BACKGROUND" internal_name="HMI_BACKGROUND" >
+        <description>
+            The application cannot interact with user via TTS, VR, display or button presses.
+        </description>
     </element>
     <element name="NONE" internal_name="HMI_NONE" >
+        <description>
+            The application has been discovered by SDL, but The app cannot send any requests or receive any notifications.
+        </description>
     </element>
 </enum>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant