Skip to content

Commit

Permalink
Merge pull request #30 from saleae/esal22-patch-1-1
Browse files Browse the repository at this point in the history
Update Analyzer_API.md
  • Loading branch information
Marcus10110 authored Oct 28, 2024
2 parents deb5da0 + 2c170c6 commit 170f083
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/Analyzer_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -497,9 +497,9 @@ Frame frame = GetFrame( frame_index );

Bubbles can display different length strings, depending on how much room is available. You should generate several results strings. The simplest might simply indicate the type of contents (‘D’ for data, for example), longer ones might indicate the full number (“0xFF01”), and longer ones might be very verbose (“Left Channel Audio Data: 0xFF01”).

To provide strings to the caller, use the ```AddStringResult``` function. This will make sure that the strings persist after the function has returned. Always call ```ClearResultStrings``` before adding any string results.
To provide strings to the caller, use the ```AddResultString``` function. This will make sure that the strings persist after the function has returned. Always call ```ClearResultStrings``` before adding any string results.

Note that to easily concatenate multiple strings, simply provide ```AddStringResult``` with more strings.
Note that to easily concatenate multiple strings, simply provide ```AddResultString``` with more strings.

```c++
void ClearResultStrings();
Expand Down Expand Up @@ -1418,4 +1418,4 @@ U32 SpiSimulationDataGenerator::GenerateSimulationData( U64 largest_sample_reque
*simulation_channels = mSpiSimulationChannels.GetArray();
return mSpiSimulationChannels.GetCount();
}
```
```

0 comments on commit 170f083

Please sign in to comment.