premake / premake/premake-core
Documentation
Open
Nobody has claimed this yet.
enhancement
help wanted
- Dominant language
- C
- Stars
- 3.6k
- Forks
- 654
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 13
Description
I generated default documentation pages for missing API's...
But they obviously need some proper documentation:
Fields
- bindirs
- buildcustomizations
- buildrule
- cdialect
- compileas
- compilebuildoutputs
- cppdialect
- customtoolnamespace
- debugconstants
- debugger
- debuggertype
- debuglevel
- debugpathmap
- debugtoolargs
- debugtoolcommand
- defaultplatform
- display
- docdir
- docname
- floatingpointexceptions
- functionlevellinking
- headerdir
- headername
- intrinsics
- largeaddressaware
- preferredtoolarchitecture
- premake5
- resourcegenerator
- sharedlibtype
- stringpooling
- tags
- versionconstants
- versionlevel
- xcodebuildresources
- xcodebuildsettings
Utility functions
- buffered.close
- buffered.new
- buffered.tostring
- buffered.write
- buffered.writeln
- criteria._compile
- criteria._delete
- criteria._word
- criteria.allowPrefix
- criteria.flatten
- criteria.matches
- criteria.new
- http.escapeUrlParam
- http.reportProgress
- io.readfile
- io.writefile
- json.encode_pretty
- os._is64bit
- os.compile
- os.getSystemTags
- os.getWindowsRegistry
- os.host
- os.ishost
- os.istarget
- os.match
- os.matchdone
- os.matchisfile
- os.matchname
- os.matchnext
- os.matchstart
- os.target
- os.touchfile
- os.translateCommandsAndPaths
- path.isasmfile
- path.isidlfile
- path.isnativefile
- path.isobjcfile
- path.isobjcppfile
- premake.alias
- premake.callArray
- premake.capture
- premake.captured
- premake.checkVersion
- premake.clearWarnings
- premake.downloadModule
- premake.eol
- premake.error
- premake.esc
- premake.escaper
- premake.filename
- premake.findProjectScript
- premake.generate
- premake.indent
- premake.info
- premake.isSemVer
- premake.out
- premake.outln
- premake.override
- premake.pop
- premake.push
- premake.quoted
- premake.resolveAlias
- premake.showhelp
- premake.touch
- premake.utf8
- premake.w
- premake.warn
- premake.warnOnce
- premake.x
- premake.xmlUtf8
- string.endswith
- table.difference
- table.equals
- table.filter
- table.insertkeyed
- table.insertsorted
- table.intersect
- table.shallowcopy
- table.unique
- term.getTextColor
- term.popColor
- term.pushColor
- term.setTextColor
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Premake wiki pages for the listed fields and utility functions, using the existing generated pages as the scope. Review the API names in each section and replace their placeholder content with accurate explanations, parameters, and usage details. Done means every listed page has proper documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100