Skip to content

Commit

Permalink
chore: update comment
Browse files Browse the repository at this point in the history
  • Loading branch information
pfeerick committed Aug 20, 2024
1 parent ea9e848 commit 5dba195
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions radio/src/lua/api_general.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1632,18 +1632,21 @@ static int luaPlayTone(lua_State * L)
}

/*luadoc
@function screenshot()
@name screenshot
Takes a screenshot
@description Takes a screenshot, which is saved to the SCREENSHOTS folder on the radio SD card.
@retval none
@syntax screenshot()
@status current Introduced in 2.11
@return none
// targets: BW, COLOR
//
// EXAMPLES:
// screenshot()
@notes This command is currently not rate limited, so repeated frequent calls will slow down the UI and can even freeze the entire radio, so should be used with care.
@target [BW]
@target [GS]
@target [COLOR]
@status current Introduced in 2.11
*/
static int luaScreenshot(lua_State * L)
{
Expand Down

0 comments on commit 5dba195

Please sign in to comment.