intel / intel/rohd-hcl

[Documentation] Add Usage examples to online github docs

Open
#192 2 comments 1 reaction 0 assignees View on GitHub
documentation enhancement help wanted
Dominant language
Dart
Stars
115
Forks
39
Avg merge
1d 13h
Merged PRs (30d)
1

Description

### Motivation

I was trying to understand how to use the DataPortInterface class using https://intel.github.io/rohd-hcl/rohd_hcl/DataPortInterface-class.html and could not figure out how I was supposed to use it.. A simple usage example of the class would go a long way for each of the classes.

### Desired solution

Class documentation includes a simple usage example the user get started using the class.

### Alternatives considered

Searching the repo for the class and figure out the usage that way.

### Additional details

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.