From 9f2c45284b219e2c04c6df7aa0507b76b5e5ccaf Mon Sep 17 00:00:00 2001
From: Frans de Jonge <fransdejonge@gmail.com>
Date: Mon, 15 Feb 2021 09:28:22 +0100
Subject: [PATCH] [chore, documentation] Fix up
 util.stringStartsWith/stringEndsWith LDoc comments (#7292)

Cf. <https://github.com/koreader/koreader/issues/7286#issuecomment-778855817>.
---
 frontend/util.lua | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/frontend/util.lua b/frontend/util.lua
index 8d522c929..8390e89d0 100644
--- a/frontend/util.lua
+++ b/frontend/util.lua
@@ -1200,18 +1200,20 @@ function util.checkLuaSyntax(lua_text)
     return err
 end
 
--- Simple startsWith / endsWith string helpers
--- c.f., http://lua-users.org/wiki/StringRecipes
--- @param str string: source string
--- @param start string: string to match
--- @return boolean: true on success
+--- Simple startsWith string helper.
+--
+-- C.f., <http://lua-users.org/wiki/StringRecipes>.
+-- @string str source string
+-- @string start string to match
+-- @treturn bool true on success
 function util.stringStartsWith(str, start)
    return str:sub(1, #start) == start
 end
 
--- @param str string: source string
--- @param ending string: string to match
--- @return boolean: true on success
+--- Simple endsWith string helper.
+-- @string str source string
+-- @string ending string to match
+-- @treturn bool true on success
 function util.stringEndsWith(str, ending)
    return ending == "" or str:sub(-#ending) == ending
 end