Описание тега luadoc
NoneIs a documentation generator tool for Lua source code. It parses the declarations and documentation comments in a set of Lua source files and produces a set of XHTML pages describing the commented declarations and functions.
2
ответа
Как использовать LuaDoc с LuaForWindows
Вопрос весь в названии: как использовать LuaDoc с LuaForWindows? В моей установке Lua у меня есть luadoc_start.bat, но окно команд закрывается, как только оно открывается. Оттуда я не знаю, что еще я могу сделать. Любая помощь? Спасибо
22 фев '13 в 21:45
1
ответ
Как использовать luadoc в Ubuntu/ Linux?
Как видно из названия, как использовать luadoc в Ubuntu/ Linux? Я сгенерировал документацию в Windows, используя командный файл, но безуспешно в Ubuntu. Есть идеи? luadoc Usage: /usr/bin/luadoc [options|files] Generate documentation from files. Avai…
05 июл '13 в 14:44
0
ответов
Должен ли я использовать LuaDoc или LDoc для проектов Lua5.1?
Каково текущее состояние LDoc и LuaDoc с точки зрения широкого использования в проектах Lua? (особенно в Lua 5.1) Вчера я проверил оба их репозитория на GitHub, и похоже, что проект Kepler объявил LuaDoc устаревшим: LuaDoc устарел, вместо этого испо…
26 фев '19 в 21:16
1
ответ
Как задокументировать закрытие с LuaDoc?
Предположим, у меня есть функция, которая возвращает замыкание: --- Agent constructor -- @return A function describing the behavior of the agent Agent = function(data) return function(arg1, arg2, ...) end end И тогда у меня есть переменная, которая …
07 мар '14 в 18:52
1
ответ
Использовать LDoc для генерации документа для всего проекта lua с индексной страницей
Я хочу создать документацию для моего lua проект, но с Ldoc я генерирую docs для каждого lua файл и выходной файл каждый раз перезаписать index.html файл. Поэтому мой вопрос в том, как я могу сгенерировать документацию для всего проекта с индексной …
17 июл '14 в 16:10
1
ответ
Использование LuaDoc с расширениями, отличными от.lua
В настоящее время я разрабатываю сценарии lua для нового приложения, для которого требуется расширение xx_lua, У меня хорошо работает luadoc для расширений.lua, и я знаю, что могу просто переименовать файлы в расширение lua, создать документы и пере…
10 сен '10 в 15:04
2
ответа
Как мне документировать, что входным параметром является таблица какого-то типа в Lua Development Tools?
Как в Lua Development Tools документировать, что входной параметр - это таблица какого-то типа? mynamespace = {} --- -- @type mynamespace.MyClass -- @field #number var1 mynamespace.MyClass = {} --- -- @param #number param1 -- @return #mynamespace.My…
27 сен '16 в 16:23
1
ответ
lua - метаданные для документации
Я прочитал комментарий от Нормана Рэмси об использовании метаданных для создания документации в lua. Я пытаюсь сгенерировать документацию из моей библиотеки, и я бы предпочел не использовать luadoc, если это возможно. Я хотел бы узнать больше об это…
23 июн '10 в 08:30
1
ответ
Регулярное выражение я не понимаю
Я играю главную роль в этих нескольких (слегка измененных) строках из luadoc, которые явно строят имя файла с полным путем. Но я просто не понимаю, что происходит в строке 5. Параметр filename может быть что-то вроде "myfile.lua". function out_file …
15 апр '11 в 17:09
2
ответа
Луа комментарий -~
Я знаю, что LuaDoc использует "---" в первой строке комментариев следующим образом: --- an example function -- @param a parameter a desc -- @param b parameter b desc function f (a,b) --code --code end Однако я вижу это в начале комментариев: --~ com…
03 авг '11 в 16:20
1
ответ
Ошибка при создании документации для lua
Я пытаюсь создать документацию для моего lua проект У меня есть мой lua папка установки и внутри нее у меня есть luafilesystem а также lualogging но когда я пытаюсь сгенерировать документ, используя luadoc-start.bat я получаю сообщение об ошибке lfs…
12 июл '14 в 12:45
0
ответов
Как отформатировать многострочные комментарии LuaDoc в коде Lua
У меня есть длинный комментарий Lua (LuaDoc), который я хочу преобразовать в многострочный комментарий с помощью команды VIM 'qgap'. Полагаю, что в.vimrc есть какое-то решение с format-comments, но я сам не смог понять это. Пример: --- This is a ver…
14 сен '12 в 11:12
0
ответов
Как указать массив в luadoc
При написании lua doc для функций вы можете указать тип возвращаемого значения. Например, я указываю, чтоmy_function вернет объект типа number. ---Function Description ---@return number A number function module.my_function() end Но я не нашел способ…
23 апр '20 в 09:26
0
ответов
Как связать параметр в функции в описании в LuaDoc
У меня есть функция Lua, которую я хочу написать: function my_func(event, handler) ... end Я хочу задокументировать параметры event и handler в той же строке моего описания, как показано ниже (если я писал JavaDoc) --- add a new {@code handler} for …
08 сен '20 в 02:06