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

[Connectivity] Add Native API reference link #2072

Open
wants to merge 25 commits into
base: master
Choose a base branch
from

Conversation

jiung-yu
Copy link

Change Description

Add API reference link in Connectivity Framework Native Guide

Bugs Fixed

Nothing

API Changes

Nothing

@TizenDocsBot
Copy link
Collaborator

Can one of the admins verify this patch?

@TizenDocsBot
Copy link
Collaborator

Please checkout the webpage https://docs1.stg.tizen.org/staging/2072

@TizenDocsBot
Copy link
Collaborator

Please checkout the webpage https://docs1.stg.tizen.org/staging/2072

@jiung-yu
Copy link
Author

LGTM

- [Connection API](../../api/common/latest/group__CAPI__NETWORK__CONNECTION__MODULE.htm)
- [Connection Manager API](../../api/common/latest/group__CAPI__NETWORK__CONNECTION__MANAGER__MODULE.html)
- [Connection Profile API] (../../api/common/latest/group__CAPI__NETWORK__CONNECTION__PROFILE__MODULE.html)
- [Wi-Fi Profile API](../../api/common/latest/group__CAPI__NETWORK__CONNECTION__WIFI__PROFILE__MODULE.html)
Copy link
Contributor

@jeik01 jeik01 Mar 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the spece between ']' and '(' should be removed.
connection_display

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

applied

@@ -820,3 +820,10 @@ done:
- Dependencies
- Tizen 2.4 and Higher for Mobile
- Tizen 2.3.1 and Higher for Wearable
- API References
- [Connection API](../../api/common/latest/group__CAPI__NETWORK__CONNECTION__MODULE.htm)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file extension is missing the 'l'.

  • "htm" -> "html"

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

applied

@TizenDocsBot
Copy link
Collaborator

Please checkout the webpage https://docs1.stg.tizen.org/staging/2072

@TizenDocsBot
Copy link
Collaborator

Please checkout the webpage https://docs1.stg.tizen.org/staging/2072

@TizenDocsBot
Copy link
Collaborator

Please checkout the webpage https://docs1.stg.tizen.org/staging/2072

@TizenDocsBot
Copy link
Collaborator

Please checkout the webpage https://docs1.stg.tizen.org/staging/2072

2 similar comments
@TizenDocsBot
Copy link
Collaborator

Please checkout the webpage https://docs1.stg.tizen.org/staging/2072

@TizenDocsBot
Copy link
Collaborator

Please checkout the webpage https://docs1.stg.tizen.org/staging/2072

@TizenDocsBot
Copy link
Collaborator

Please checkout the webpage https://docs1.stg.tizen.org/staging/2072

Copy link
Collaborator

@maliha-samsung maliha-samsung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @jiung-yu please check and incorporate the changes accordingly.

Comment on lines 533 to 537
- Dependencies
- Tizen 2.4 and Higher for Mobile
- Tizen 2.3.1 and Higher for Wearable
-API Reference
- [Convergence API](../../api/common/latest/group__CAPI__CONVERGENCE__FRAMEWORK.html)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Dependencies
- Tizen 2.4 and Higher for Mobile
- Tizen 2.3.1 and Higher for Wearable
-API Reference
- [Convergence API](../../api/common/latest/group__CAPI__CONVERGENCE__FRAMEWORK.html)
- Dependencies
- Tizen 2.4 and Higher for Mobile
- Tizen 2.3.1 and Higher for Wearable
- API References
- [Convergence API](../../api/common/latest/group__CAPI__CONVERGENCE__FRAMEWORK.html)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -216,3 +216,5 @@ To download content:
## Related Information
- Dependencies
- Tizen 2.4 and Higher for Mobile
- API Reference
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- API Reference
- API References

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -285,3 +285,5 @@ if (ret != HTTP_ERROR_NONE)
- Dependencies
- Tizen 3.0 and Higher for Mobile
- Tizen 3.0 and Higher for Wearable
- API Reference
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- API Reference
- API References

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -168,3 +168,5 @@ You can monitor other types of state changes using certain callback functions, s
- Tizen 5.0 and Higher for Mobile
- Tizen 5.0 and Higher for Wearable
- Tizen 5.0 and Higher for TV
- API Reference
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- API Reference
- API References

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -340,3 +340,5 @@ To release the SoftAP resources:
- Dependencies
- Tizen 5.0 and Higher for Mobile
- Tizen 5.0 and Higher for Wearable
- API Reference
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- API Reference
- API References

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -269,3 +269,5 @@ To retrieve statistics about total network data consumed by applications:
- Dependencies
- Tizen 4.0 and Higher for Mobile
- Tizen 4.0 and Higher for Wearable
- API Reference
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- API Reference
- API References

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -423,3 +423,5 @@ To read or write data:
## Related Information
- Dependencies
- Tizen 3.0 and Higher for Mobile
- API Reference
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- API Reference
- API References

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -424,3 +424,5 @@ To deactivate Wi-Fi Direct when it is no longer needed (or the application is ex
## Related Information
- Dependencies
- Tizen 2.4 and Higher for Mobile
- API Reference
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- API Reference
- API References

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Collaborator

@maliha-samsung maliha-samsung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jiung-yu Please check the suggestions

@@ -530,6 +530,8 @@ The success or failure result (including the correctness of the passcode input i
| `conv_service_stop()` | `"result_type"`: `"onStop"` |

## Related Information
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Related Information
## Related information

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -216,3 +216,5 @@ To download content:
## Related Information
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Related Information
## Related information

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -414,3 +414,8 @@ application_test_event_callback(void)
## Related Information
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Related Information
## Related information

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -241,9 +241,12 @@ dlog_print(DLOG_INFO, LOG_TAG, "%d bytes of response received: %s", bytes_transf
## Asynchronous Transfer

Asynchronous transfer is a way to allow the system to handle the data traffic in the background without having to wait for the asynchronous transfer to finish. A program can request an asynchronous transfer and proceed with its operations. The program is notified by the system as soon as the request is handled.
The asynchronous transfer includes isochronous and control transfers. For more information and examples, see [Asynchronous IO](../../api/mobile/latest/group__CAPI__USB__HOST__ASYNC__MODULE.html).
The asynchronous transfer includes isochronous and control transfers. For more information and examples, see [Asynchronous IO API](../../api/common/latest/group__CAPI__USB__HOST__ASYNC__MODULE.html).


## Related Information
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Related Information
## Related information

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -423,3 +423,5 @@ To read or write data:
## Related Information
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Related Information
## Related information

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -424,3 +424,5 @@ To deactivate Wi-Fi Direct when it is no longer needed (or the application is ex
## Related Information
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Related Information
## Related information

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@TizenDocsBot
Copy link
Collaborator

Please checkout the webpage https://docs1.stg.tizen.org/staging/2072

1 similar comment
@TizenDocsBot
Copy link
Collaborator

Please checkout the webpage https://docs1.stg.tizen.org/staging/2072

Copy link
Collaborator

@maliha-samsung maliha-samsung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jiung-yu please check the fixes and incorporate accordingly, thank you.

Comment on lines +533 to +537
- Dependencies
- Tizen 2.4 and Higher for Mobile
- Tizen 2.3.1 and Higher for Wearable
- API References
- [Convergence API](../../api/common/latest/group__CAPI__CONVERGENCE__FRAMEWORK.html)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Dependencies
- Tizen 2.4 and Higher for Mobile
- Tizen 2.3.1 and Higher for Wearable
- API References
- [Convergence API](../../api/common/latest/group__CAPI__CONVERGENCE__FRAMEWORK.html)
- Dependencies
- Tizen 2.4 and Higher for Mobile
- Tizen 2.3.1 and Higher for Wearable
- API References
- [Convergence API](../../api/common/latest/group__CAPI__CONVERGENCE__FRAMEWORK.html)

Comment on lines 30 to 32
* Dependencies
- Tizen 2.4 and Higher for Mobile
- Tizen 2.3.1 and Higher for Wearable
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Dependencies
- Tizen 2.4 and Higher for Mobile
- Tizen 2.3.1 and Higher for Wearable
- Dependencies
- Tizen 2.4 and Higher for Mobile
- Tizen 2.3.1 and Higher for Wearable

Comment on lines 340 to +344
- Dependencies
- Tizen 5.0 and Higher for Mobile
- Tizen 5.0 and Higher for Wearable
- API References
- [SoftAP API](../../api/common/latest/group__CAPI__NETWORK__SOFTAP__MODULE.html)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Dependencies
- Tizen 5.0 and Higher for Mobile
- Tizen 5.0 and Higher for Wearable
- API References
- [SoftAP API](../../api/common/latest/group__CAPI__NETWORK__SOFTAP__MODULE.html)
- Dependencies
- Tizen 5.0 and Higher for Mobile
- Tizen 5.0 and Higher for Wearable
- API References
- [SoftAP API](../../api/common/latest/group__CAPI__NETWORK__SOFTAP__MODULE.html)

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

Successfully merging this pull request may close these issues.

5 participants