mirrors/sway
1
0
Fork 0
mirror of https://github.com/swaywm/sway.git synced 2026-04-29 06:46:22 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

config: Improve and add comments for line reading

Browse source
This commit is contained in:
Michael Schupikov 2017-01-09 17:00:33 +01:00
parent 5fc855dbd5
commit e039c98fc4
2 changed files with 43 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

12
common/readline.c
View file

@ -9,15 +9,13 @@
/***************************************************************************//**
*
* \brief Read one line of the configuration file.
* \brief Read one line of the file. Lines beginning with '#' are skipped.
* Whitespace is stripped.
*
* \param file Pointer to the already open configuration file. If NULL is
* passed, no operation is performed.
* \param[in] file Pointer to the already open configuration file. If NULL is
* passed, no operation is performed.
*
* \return String containing one single line from the configuration file.
* This string is not necessarily in the format how it is expected
* for further processing of configuration commands. NULL is
* returned in case of failure or if NULL is passed for 'file'.
* \return String containing one single line from the file.
*
******************************************************************************/
inline char* read_line(FILE* restrict const file) {