Codebase list lua-ldoc / 8d22dc7
new flag --tags and some more builtin tags. So --tag fixme will show all occurances of @fixme in a project steve donovan 12 years ago
2 changed file(s) with 25 addition(s) and 1 deletion(s). Raw diff Collapse all Expand all
+17
-1
ldoc/doc.lua less more
1616 local known_tags = {
1717 param = 'M', see = 'M', usage = 'M', ['return'] = 'M', field = 'M', author='M';
1818 class = 'id', name = 'id', pragma = 'id', alias = 'id';
19 copyright = 'S', summary = 'S', description = 'S', release = 'S', license = 'S';
19 copyright = 'S', summary = 'S', description = 'S', release = 'S', license = 'S',
20 fixme = 'S', todo = 'S', warning = 'S';
2021 module = 'T', script = 'T', example = 'T', topic = 'T', -- project-level
2122 ['function'] = 'T', lfunction = 'T', table = 'T', section = 'T', type = 'T'; -- module-level
2223 ['local'] = 'N';
407408 self.kinds['Local Functions'] = nil
408409 end
409410
411 function Item:dump_tags (taglist)
412 for tag, value in pairs(self.tags) do
413 if not taglist or taglist[tag] then
414 Item.warning(self,self.name..' '..tag..' '..tostring(value))
415 end
416 end
417 end
418
419 function Module:dump_tags (taglist)
420 Item.dump_tags(self,taglist)
421 for item in self.items:iter() do
422 item:dump_tags(taglist)
423 end
424 end
425
410426 --------- dumping out modules and items -------------
411427
412428 function Module:dump(verbose)
+8
-0
ldoc.lua less more
3131 -c,--config (default config.ld) configuration name
3232 --dump debug output dump
3333 --filter (default none) filter output as Lua data (e.g pl.pretty.dump)
34 --tags (default none) show all references to a given tag
3435 <file> (string) source file or directory containing source
3536 ]]
3637
408409 end
409410 os.exit()
410411 end
412 if args.tags then
413 local taglist = {[args.tags] = true}
414 for mod in module_list:iter() do
415 mod:dump_tags(taglist)
416 end
417 os.exit()
418 end
411419
412420 -- ldoc --filter mod.name will load the module `mod` and pass the object graph
413421 -- to the function `name`. As a special case --filter dump will use pl.pretty.dump.