Skip to content

[Documentation] Add Usage examples to online github docs #192

Open
@awmoore-intel

Description

@awmoore-intel

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requesthelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions