Mirror/ardupilot
5
0
Fork 0
mirror of https://github.com/ArduPilot/ardupilot synced 2025-01-22 16:48:29 -04:00
Code Issues Packages Projects Releases Wiki Activity

AP_HAL_Linux: document functions to write file

Browse Source 
Document function and add attributes to mark then as printf- and
scanf-like functions.
This commit is contained in:
Lucas De Marchi 2015-11-06 01:46:33 -02:00 committed by Andrew Tridgell
parent 821814007e
commit 392879112e
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
libraries/AP_HAL_Linux/Util.h
View File

@ -2,7 +2,9 @@
#ifndef __AP_HAL_LINUX_UTIL_H__
#define __AP_HAL_LINUX_UTIL_H__
#include <AP_Common/AP_Common.h>
#include <AP_HAL/AP_HAL.h>
#include "AP_HAL_Linux_Namespace.h"
#include "ToneAlarmDriver.h"
@ -40,8 +42,19 @@ public:
uint32_t available_memory(void) override;
int write_file(const char *path, const char *fmt, ...);
int read_file(const char *path, const char *fmt, ...);
/*
* Write a string as specified by @fmt to the file in @path. Note this
* should not be used on hot path since it will open, write and close the
* file for each call.
*/
int write_file(const char *path, const char *fmt, ...) FORMAT(3, 4);
/*
* Read a string as specified by @fmt from the file in @path. Note this
* should not be used on hot path since it will open, read and close the
* file for each call.
*/
int read_file(const char *path, const char *fmt, ...) FMT_SCANF(3, 4);
private:
static Linux::ToneAlarm _toneAlarm;