module(...) name deduction failed:

[tuxd3v]

Hello I have this config.ld:

project='LNewt'
title='Lua Bindings for Newt Library'
description='Lnewt Simple Library.'
-- format - 'markdown|discount|lunamark|plain|backticks'
format='discount'
all=true
colon=false
charset='en_GB.UTF-8'
style='!pale'
backtick_references=false
add_language_extension('lua','c','h')
kind_names={topic='Manual',script='Programs'}

readme='doc.md'
-- Input folders do Document
file={
	'../src',
	'../include'
}

-- Output Documents
dir='../docs'

-- See references to examples..
examples = {
	'../test',
	exclude = {
		'../test/edev1.lua'
	}
}

I run ldoc, from the inside of 'docs'( which is the output folder.. ), folder..

Every-time that I try to run ldoc I get lots of errors, then at final:

module(...) name deduction failed: base /home/user/path/lnewt/src/  /home/user/path/lnewt/include/lnewt.h

My project, that I am trying to Document is this.

Thanks in Advance, tux

[tuxd3v]

an execution call:

docs$ lua /path/to/LDoc/ldoc.lua .
reading configuration from config.ld
lnewt.c:7: ?: unknown tag: 'brief' nil
lnewt.c:35: ?: unknown tag: 'brief' nil
lnewt.c:57: ?: unknown tag: 'brief' nil
lnewt.c:57: ?: unknown tag: 'returns' nil
lnewt.c:68: ?: unknown tag: 'brief' nil
lnewt.c:68: ?: unknown tag: 'returns' nil
lnewt.c:79: ?: unknown tag: 'brief' nil
lnewt.c:96: ?: unknown tag: 'brief' nil
lnewt.c:113: ?: unknown tag: 'brief' nil
lnewt.c:217: ?: unknown tag: 'brief' nil
lnewt.c:217: ?: unknown tag: 'returns' nil
lnewt.c:297: ?: unknown tag: 'brief' nil
lnewt.c:297: ?: unknown tag: 'returns' nil
lnewt.c:310: ?: unknown tag: 'brief' nil
lnewt.c:310: ?: unknown tag: 'returns' nil
lnewt.c:321: ?: unknown tag: 'brief' nil
lnewt.c:321: ?: unknown tag: 'returns' nil
lnewt.c:332: ?: unknown tag: 'brief' nil
lnewt.c:332: ?: unknown tag: 'returns' nil
lnewt.c:343: ?: unknown tag: 'brief' nil
lnewt.c:343: ?: unknown tag: 'returns' nil
lnewt.c:357: ?: unknown tag: 'brief' nil
lnewt.c:357: ?: unknown tag: 'returns' nil
lnewt.c:379: ?: unknown tag: 'brief' nil
lnewt.c:379: ?: unknown tag: 'returns' nil
lnewt.c:402: ?: unknown tag: 'brief' nil
lnewt.c:402: ?: unknown tag: 'returns' nil
lnewt.c:413: ?: unknown tag: 'brief' nil
lnewt.c:413: ?: unknown tag: 'returns' nil
lnewt.c:431: ?: unknown tag: 'brief' nil
lnewt.c:431: ?: unknown tag: 'returns' nil
lnewt.c:442: ?: unknown tag: 'brief' nil
lnewt.c:442: ?: unknown tag: 'returns' nil
lnewt.c:453: ?: unknown tag: 'brief' nil
lnewt.c:453: ?: unknown tag: 'returns' nil
lnewt.c:466: ?: unknown tag: 'brief' nil
lnewt.c:466: ?: unknown tag: 'returns' nil
lnewt.c:478: ?: unknown tag: 'brief' nil
lnewt.c:478: ?: unknown tag: 'returns' nil
lnewt.c:489: ?: unknown tag: 'brief' nil
lnewt.c:489: ?: unknown tag: 'returns' nil
lnewt.c:500: ?: unknown tag: 'brief' nil
lnewt.c:500: ?: unknown tag: 'returns' nil
lnewt.c:511: ?: unknown tag: 'brief' nil
lnewt.c:511: ?: unknown tag: 'returns' nil
lnewt.c:522: ?: unknown tag: 'brief' nil
lnewt.c:522: ?: unknown tag: 'returns' nil
lnewt.c:535: ?: unknown tag: 'brief' nil
lnewt.c:535: ?: unknown tag: 'returns' nil
lnewt.c:552: ?: unknown tag: 'brief' nil
lnewt.c:552: ?: unknown tag: 'returns' nil
lnewt.c:573: ?: unknown tag: 'brief' nil
lnewt.c:573: ?: unknown tag: 'returns' nil
lnewt.c:594: ?: unknown tag: 'brief' nil
lnewt.c:594: ?: unknown tag: 'returns' nil
lnewt.c:623: ?: unknown tag: 'brief' nil
lnewt.c:623: ?: unknown tag: 'returns' nil
lnewt.c:652: ?: unknown tag: 'brief' nil
lnewt.c:652: ?: unknown tag: 'returns' nil
lnewt.c:682: ?: unknown tag: 'brief' nil
lnewt.c:682: ?: unknown tag: 'returns' nil
lnewt.c:702: ?: unknown tag: 'brief' nil
lnewt.c:702: ?: unknown tag: 'returns' nil
lnewt.c:728: ?: unknown tag: 'brief' nil
lnewt.c:728: ?: unknown tag: 'returns' nil
lnewt.c:752: ?: unknown tag: 'brief' nil
lnewt.c:752: ?: unknown tag: 'returns' nil
lnewt.c:788: ?: unknown tag: 'brief' nil
lnewt.c:788: ?: unknown tag: 'returns' nil
lnewt.c:809: ?: unknown tag: 'brief' nil
lnewt.c:809: ?: unknown tag: 'returns' nil
lnewt.c:820: ?: unknown tag: 'brief' nil
lnewt.c:820: ?: unknown tag: 'returns' nil
lnewt.c:857: ?: unknown tag: 'brief' nil
lnewt.c:857: ?: unknown tag: 'returns' nil
lnewt.c:889: ?: unknown tag: 'brief' nil
lnewt.c:889: ?: unknown tag: 'returns' nil
lnewt.c:929: ?: unknown tag: 'brief' nil
lnewt.c:929: ?: unknown tag: 'returns' nil
lnewt.c:944: ?: unknown tag: 'brief' nil
lnewt.c:944: ?: unknown tag: 'returns' nil
lnewt.c:959: ?: unknown tag: 'brief' nil
lnewt.c:959: ?: unknown tag: 'returns' nil
lnewt.c:974: ?: unknown tag: 'brief' nil
lnewt.c:974: ?: unknown tag: 'returns' nil
lnewt.c:1002: ?: unknown tag: 'brief' nil
lnewt.c:1002: ?: unknown tag: 'returns' nil
lnewt.c:1030: ?: unknown tag: 'brief' nil
lnewt.c:1030: ?: unknown tag: 'returns' nil
lnewt.c:1047: ?: unknown tag: 'brief' nil
lnewt.c:1047: ?: unknown tag: 'returns' nil
lnewt.c:1070: ?: unknown tag: 'brief' nil
lnewt.c:1070: ?: unknown tag: 'returns' nil
lnewt.c:1103: ?: unknown tag: 'brief' nil
lnewt.c:1103: ?: unknown tag: 'returns' nil
lnewt.c:1120: ?: unknown tag: 'brief' nil
lnewt.c:1120: ?: unknown tag: 'returns' nil
lnewt.c:1144: ?: unknown tag: 'brief' nil
lnewt.c:1144: ?: unknown tag: 'returns' nil
lnewt.c:1170: ?: unknown tag: 'brief' nil
lnewt.c:1170: ?: unknown tag: 'returns' nil
lnewt.c:1189: ?: unknown tag: 'brief' nil
lnewt.c:1189: ?: unknown tag: 'returns' nil
lnewt.c:1204: ?: unknown tag: 'brief' nil
lnewt.c:1204: ?: unknown tag: 'returns' nil
lnewt.c:1227: ?: unknown tag: 'brief' nil
lnewt.c:1227: ?: unknown tag: 'returns' nil
lnewt.c:1237: ?: unknown tag: 'brief' nil
lnewt.c:1237: ?: unknown tag: 'returns' nil
lnewt.c:1247: ?: unknown tag: 'brief' nil
lnewt.c:1247: ?: unknown tag: 'returns' nil
lnewt.c:1256: ?: unknown tag: 'brief' nil
lnewt.c:1256: ?: unknown tag: 'returns' nil
lnewt.c:1267: ?: unknown tag: 'brief' nil
lnewt.c:1267: ?: unknown tag: 'returns' nil
lnewt.c:1278: ?: unknown tag: 'brief' nil
lnewt.c:1278: ?: unknown tag: 'returns' nil
lnewt.c:1289: ?: unknown tag: 'brief' nil
lnewt.c:1289: ?: unknown tag: 'returns' nil
lnewt.c:1300: ?: unknown tag: 'brief' nil
lnewt.c:1300: ?: unknown tag: 'returns' nil
lnewt.c:1311: ?: unknown tag: 'brief' nil
lnewt.c:1311: ?: unknown tag: 'returns' nil
lnewt.c:1322: ?: unknown tag: 'brief' nil
lnewt.c:1322: ?: unknown tag: 'returns' nil
lnewt.c:1333: ?: unknown tag: 'brief' nil
lnewt.c:1333: ?: unknown tag: 'returns' nil
lnewt.c:1344: ?: unknown tag: 'brief' nil
lnewt.c:1344: ?: unknown tag: 'returns' nil
lnewt.c:1355: ?: unknown tag: 'brief' nil
lnewt.c:1355: ?: unknown tag: 'returns' nil
lnewt.c:1366: ?: unknown tag: 'brief' nil
lnewt.c:1366: ?: unknown tag: 'returns' nil
lnewt.c:1377: ?: unknown tag: 'brief' nil
lnewt.c:1377: ?: unknown tag: 'returns' nil
lnewt.c:1388: ?: unknown tag: 'brief' nil
lnewt.c:1388: ?: unknown tag: 'returns' nil
lnewt.c:1399: ?: unknown tag: 'brief' nil
lnewt.c:1399: ?: unknown tag: 'returns' nil

Does LDoc knows about @brief,@returns tags?

[tuxd3v]

ok, I substituted, @returns by @return and @brief by @summary

now I get:

/home/path/to/project/lnewt/docs$ lua /home/path/to/LDoc/ldoc.lua .
reading configuration from config.ld
module(...) name deduction failed: base /home/path/to/project/lnewt/src/ /home/path/to/project//include/lnewt.h

Does any one knows why it fails to create documentation?

[tuxd3v]

Can anyone help me setting up the documentation with LDOC ?

Thanks in Advance, Best Regards, tux

[cloewen8]

Have you tried adding @module lnewt to the first LDoc comment? I commonly get this error if I don't do the same.

[tuxd3v]

@cloewen8, thanks for the help :) I will try that..

Does I need to do the same for any LDoc comment section? Thanks in Advance Best Regards tux

[cloewen8]

@tuxd3v Seemed to only be the case for C comments. Regular Lua comments from what I recall work fine without.