| main |
function |
function main(args) |
| minidoc.analyzer._addEnum |
function |
function _addEnum(project, file, node, prefix, namespace_name) |
| minidoc.analyzer._addExternFunction |
function |
function _addExternFunction(project, file, node, prefix, namespace_name) |
| minidoc.analyzer._addFunction |
function |
function _addFunction(project, file, node, kind, prefix, namespace_name, container_id) |
| minidoc.analyzer._addInterface |
function |
function _addInterface(project, file, node, prefix, namespace_name) |
| minidoc.analyzer._addStruct |
function |
function _addStruct(project, file, node, prefix, namespace_name) |
| minidoc.analyzer._addSymbol |
function |
function _addSymbol(project, file, kind, name, qualified_name, container_id, namespace_name, position, signature, type_name, modifiers, parameters, return_type, doc) |
| minidoc.analyzer._aliasTargetPackage |
function |
function _aliasTargetPackage(project, file_id, alias) |
| minidoc.analyzer._calleeName |
function |
function _calleeName(expr) |
| minidoc.analyzer._diagnostic |
function |
function _diagnostic(project, severity, code, file, position, message) |
| minidoc.analyzer._fileById |
function |
function _fileById(project, id) |
| minidoc.analyzer._findWord |
function |
function _findWord(source, name, start_pos, docs) |
| minidoc.analyzer._functionParameters |
function |
function _functionParameters(node, doc) |
| minidoc.analyzer._functionSignature |
function |
function _functionSignature(node, parameters, name, kind) |
| minidoc.analyzer._insideDocumentation |
function |
function _insideDocumentation(docs, position) |
| minidoc.analyzer._isPositiveDecimal |
function |
function _isPositiveDecimal(value) |
| minidoc.analyzer._isTestRoleTag |
function |
function _isTestRoleTag(name) |
| minidoc.analyzer._operatorQualifiedName |
function |
function _operatorQualifiedName(prefix, operator_symbol, parameters) |
| minidoc.analyzer._operatorSignature |
function |
function _operatorSignature(node, parameters, operator_symbol) |
| minidoc.analyzer._operatorSourceSymbol |
function |
function _operatorSourceSymbol(name) |
| minidoc.analyzer._parameterSignaturePieces |
function |
function _parameterSignaturePieces(parameters) |
| minidoc.analyzer._qualified |
function |
function _qualified(prefix, name) |
| minidoc.analyzer._resolveCalls |
function |
function _resolveCalls(project) |
| minidoc.analyzer._resolveTypeRelations |
function |
function _resolveTypeRelations(project) |
| minidoc.analyzer._resolveUnique |
function |
function _resolveUnique(project, candidates, allowed_kinds) |
| minidoc.analyzer._scope |
function |
function _scope(package_name, namespace_name) |
| minidoc.analyzer._summaryQualityEligible |
function |
function _summaryQualityEligible(project, doc_symbol) |
| minidoc.analyzer._symbolById |
function |
function _symbolById(project, id) |
| minidoc.analyzer._symbolId |
function |
function _symbolId(kind, qualified_name, signature, file_path) |
| minidoc.analyzer._typeName |
function |
function _typeName(value, optional) |
| minidoc.analyzer._validateCoverage |
function |
function _validateCoverage(project) |
| minidoc.analyzer._validateFunctionDoc |
function |
function _validateFunctionDoc(project, file, node, doc, parameters, return_type, internal, kind) |
| minidoc.analyzer._validateSummaryQuality |
function |
function _validateSummaryQuality(project) |
| minidoc.analyzer._validateTestFixtureUniqueness |
function |
function _validateTestFixtureUniqueness(project) |
| minidoc.analyzer._validateTestTags |
function |
function _validateTestTags(project, file, node, doc, parameters, return_type, kind) |
| minidoc.analyzer._walkDeclarations |
function |
function _walkDeclarations(project, file, body, namespace_name) |
| minidoc.analyzer._walkExpression |
function |
function _walkExpression(project, file, caller, expr, namespace_name) |
| minidoc.analyzer._walkNested |
function |
function _walkNested(project, file, body, parent, namespace_name) |
| minidoc.analyzer._walkStatementsForCalls |
function |
function _walkStatementsForCalls(project, file, caller, body, namespace_name) |
| minidoc.analyzer._warningScopeIncludes |
function |
function _warningScopeIncludes(scope, internal) |
| minidoc.analyzer.analyze |
function |
function analyze(project) |
| minidoc.analyzer.expressionText |
function |
function expressionText(expr) |
| minidoc.app._countSeverity |
function |
function _countSeverity(project, severity) |
| minidoc.app._generationTimestamp |
function |
function _generationTimestamp(cfg) |
| minidoc.app._hasArg |
function |
function _hasArg(args, value) |
| minidoc.app._printDiagnostics |
function |
function _printDiagnostics(project) |
| minidoc.app._sourceDateEpochTimestamp |
function |
function _sourceDateEpochTimestamp(raw) |
| minidoc.app.generate |
function |
function generate(cfg) |
| minidoc.app.printHelp |
function |
function printHelp() |
| minidoc.app.printVersion |
function |
function printVersion() |
| minidoc.app.render |
function |
function render(project) |
| minidoc.app.run |
function |
function run(args) |
| minidoc.app.VERSION |
constant |
const VERSION = "0.4.3" |
| minidoc.config._absoluteItems |
function |
function _absoluteItems(items, base) |
| minidoc.config._applyCli |
function |
function _applyCli(cfg, args) |
| minidoc.config._applyFormats |
function |
function _applyFormats(cfg, raw) |
| minidoc.config._applyGraphSelection |
function |
function _applyGraphSelection(cfg, raw) |
| minidoc.config._applyMiniDoc |
function |
function _applyMiniDoc(cfg, path) |
| minidoc.config._applyProject |
function |
function _applyProject(cfg, path) |
| minidoc.config._argValue |
function |
function _argValue(args, names) |
| minidoc.config._boolean |
function |
function _boolean(value) |
| minidoc.config._integer |
function |
function _integer(value) |
| minidoc.config._manifestFromConfig |
function |
function _manifestFromConfig(path) |
| minidoc.config._rowArray |
function |
function _rowArray(row, path) |
| minidoc.config._rowBool |
function |
function _rowBool(row, path) |
| minidoc.config._rowInt |
function |
function _rowInt(row, path) |
| minidoc.config._rows |
function |
function _rows(path) |
| minidoc.config._rowString |
function |
function _rowString(row, path) |
| minidoc.config._stringArray |
function |
function _stringArray(value) |
| minidoc.config._unquote |
function |
function _unquote(value) |
| minidoc.config.load |
function |
function load(args) |
| minidoc.config.TomlRow |
struct |
struct TomlRow |
| minidoc.config.TomlRow.key |
field |
key |
| minidoc.config.TomlRow.line |
field |
line |
| minidoc.config.TomlRow.section |
field |
section |
| minidoc.config.TomlRow.value |
field |
value |
| minidoc.doc_comments._cleanBlockLine |
function |
function _cleanBlockLine(value) |
| minidoc.doc_comments._finishPending |
function |
function _finishPending(docs, pending_kind, pending_start, pending_end, pending_start_line, pending_end_line, pending_lines) |
| minidoc.doc_comments._firstWord |
function |
function _firstWord(value) |
| minidoc.doc_comments._parseBlock |
function |
function _parseBlock(target_kind, start_pos, end_pos, start_line, end_line, raw_lines) |
| minidoc.doc_comments._stripOneSpace |
function |
function _stripOneSpace(value) |
| minidoc.doc_comments._summaryAndDetails |
function |
function _summaryAndDetails(body) |
| minidoc.doc_comments.documentationBefore |
function |
function documentationBefore(docs, source, position) |
| minidoc.doc_comments.fileDocumentation |
function |
function fileDocumentation(docs) |
| minidoc.doc_comments.hasTag |
function |
function hasTag(doc, name) |
| minidoc.doc_comments.scan |
function |
function scan(source) |
| minidoc.doc_comments.tagText |
function |
function tagText(doc, name, key) |
| minidoc.graph._addNode |
function |
function _addNode(nodes, id, label, kind, maximum) |
| minidoc.graph._entityOwned |
function |
function _entityOwned(project, id) |
| minidoc.graph._entityPackage |
function |
function _entityPackage(project, id) |
| minidoc.graph._hasEdge |
function |
function _hasEdge(relations, from_id, to_id) |
| minidoc.graph._nodeIndex |
function |
function _nodeIndex(nodes, id) |
| minidoc.graph._relationVisible |
function |
function _relationVisible(project, relation) |
| minidoc.graph._shortLabel |
function |
function _shortLabel(value) |
| minidoc.graph._sortNodes |
function |
function _sortNodes(nodes) |
| minidoc.graph._symbolLabel |
function |
function _symbolLabel(project, id) |
| minidoc.graph.GraphNode |
struct |
struct GraphNode |
| minidoc.graph.GraphNode.id |
field |
id |
| minidoc.graph.GraphNode.kind |
field |
kind |
| minidoc.graph.GraphNode.label |
field |
label |
| minidoc.graph.hasRelations |
function |
function hasRelations(project, relation_kind) |
| minidoc.graph.renderSvg |
function |
function renderSvg(project, relation_kind, title) |
| minidoc.loader._collectTree |
function |
function _collectTree(path, root, cfg, files, seen_dirs) |
| minidoc.loader._diagnostic |
function |
function _diagnostic(project, severity, code, path, source, position, message) |
| minidoc.loader._fileId |
function |
function _fileId(root, path) |
| minidoc.loader._findFile |
function |
function _findFile(project, path) |
| minidoc.loader._hasLicenseHeader |
function |
function _hasLicenseHeader(source) |
| minidoc.loader._isExcluded |
function |
function _isExcluded(path, root, cfg) |
| minidoc.loader._isReachable |
function |
function _isReachable(reachable_paths, path) |
| minidoc.loader._loadImports |
function |
function _loadImports(project, file, queue, reachable_paths) |
| minidoc.loader._markReachable |
function |
function _markReachable(project, path) |
| minidoc.loader._parseFile |
function |
function _parseFile(project, path, reachable) |
| minidoc.loader._programPackage |
function |
function _programPackage(program) |
| minidoc.loader._resolveImport |
function |
function _resolveImport(request, importer_path, cfg) |
| minidoc.loader.discover |
function |
function discover(cfg) |
| minidoc.loader.loadProject |
function |
function loadProject(cfg) |
| minidoc.metrics._accumulateHalstead |
function |
function _accumulateHalstead(accumulator, source) |
| minidoc.metrics._appendFunctionAndNested |
function |
function _appendFunctionAndNested(project, file, normalized_lines, node, output) |
| minidoc.metrics._appendFunctionMetric |
function |
function _appendFunctionMetric(project, file, normalized_lines, node, output) |
| minidoc.metrics._booleanOperators |
function |
function _booleanOperators(expr) |
| minidoc.metrics._calculateDuplicates |
function |
function _calculateDuplicates(sources) |
| minidoc.metrics._collectFunctions |
function |
function _collectFunctions(project, file, normalized_lines, body, output) |
| minidoc.metrics._commentFlags |
function |
function _commentFlags(source) |
| minidoc.metrics._complexity |
function |
function _complexity(body) |
| minidoc.metrics._coverageMetric |
function |
function _coverageMetric(documented, total) |
| minidoc.metrics._duplicatedLineCount |
function |
function _duplicatedLineCount(source_data) |
| minidoc.metrics._findFunctionSymbol |
function |
function _findFunctionSymbol(project, file_id, position) |
| minidoc.metrics._finishHalstead |
function |
function _finishHalstead(accumulator) |
| minidoc.metrics._functionEndLine |
function |
function _functionEndLine(normalized_lines, start_line) |
| minidoc.metrics._functionTotals |
function |
function _functionTotals(function_metrics, file_id) |
| minidoc.metrics._halstead |
function |
function _halstead(source) |
| minidoc.metrics._isDocumentable |
function |
function _isDocumentable(doc_symbol) |
| minidoc.metrics._isDocumentableCallable |
function |
function _isDocumentableCallable(doc_symbol) |
| minidoc.metrics._isMeasuredFile |
function |
function _isMeasuredFile(project, file) |
| minidoc.metrics._maintainability |
function |
function _maintainability(volume, cyclomatic, source_lines) |
| minidoc.metrics._markWindow |
function |
function _markWindow(source_data, start, count) |
| minidoc.metrics._newHalsteadAccumulator |
function |
function _newHalsteadAccumulator() |
| minidoc.metrics._normalizedLines |
function |
function _normalizedLines(source) |
| minidoc.metrics._recordOperand |
function |
function _recordOperand(accumulator, value) |
| minidoc.metrics._recordOperator |
function |
function _recordOperator(accumulator, value) |
| minidoc.metrics._round2 |
function |
function _round2(value) |
| minidoc.metrics._sourceData |
function |
function _sourceData(file) |
| minidoc.metrics._sourceDataById |
function |
function _sourceDataById(sources, file_id) |
| minidoc.metrics._sourceLines |
function |
function _sourceLines(source) |
| minidoc.metrics._sourceSlice |
function |
function _sourceSlice(source, start_line, end_line) |
| minidoc.metrics._startsFunction |
function |
function _startsFunction(line) |
| minidoc.metrics._startsOperator |
function |
function _startsOperator(line) |
| minidoc.metrics._tokenValue |
function |
function _tokenValue(tokens, index) |
| minidoc.metrics._touchNesting |
function |
function _touchNesting(accumulator, nesting) |
| minidoc.metrics._walkComplexity |
function |
function _walkComplexity(body, accumulator, nesting) |
| minidoc.metrics._walkNestedFunctions |
function |
function _walkNestedFunctions(project, file, normalized_lines, body, output) |
| minidoc.metrics._windowFingerprint |
function |
function _windowFingerprint(lines, start, count) |
| minidoc.metrics.calculate |
function |
function calculate(project) |
| minidoc.metrics.CLONE_DETAIL_LIMIT |
constant |
const CLONE_DETAIL_LIMIT = 200 |
| minidoc.metrics.ComplexityAccumulator |
struct |
struct ComplexityAccumulator |
| minidoc.metrics.ComplexityAccumulator.cognitive_complexity |
field |
cognitive_complexity |
| minidoc.metrics.ComplexityAccumulator.cyclomatic_complexity |
field |
cyclomatic_complexity |
| minidoc.metrics.ComplexityAccumulator.maximum_nesting |
field |
maximum_nesting |
| minidoc.metrics.ComplexityAccumulator.statement_count |
field |
statement_count |
| minidoc.metrics.DUPLICATE_WINDOW_SIZE |
constant |
const DUPLICATE_WINDOW_SIZE = 6 |
| minidoc.metrics.HalsteadAccumulator |
struct |
struct HalsteadAccumulator |
| minidoc.metrics.HalsteadAccumulator.distinct_operands |
field |
distinct_operands |
| minidoc.metrics.HalsteadAccumulator.distinct_operators |
field |
distinct_operators |
| minidoc.metrics.HalsteadAccumulator.operands |
field |
operands |
| minidoc.metrics.HalsteadAccumulator.operators |
field |
operators |
| minidoc.metrics.HalsteadAccumulator.total_operands |
field |
total_operands |
| minidoc.metrics.HalsteadAccumulator.total_operators |
field |
total_operators |
| minidoc.metrics.SourceMetricsData |
struct |
struct SourceMetricsData |
| minidoc.metrics.SourceMetricsData.blank_lines |
field |
blank_lines |
| minidoc.metrics.SourceMetricsData.comment_flags |
field |
comment_flags |
| minidoc.metrics.SourceMetricsData.comment_lines |
field |
comment_lines |
| minidoc.metrics.SourceMetricsData.duplicate_flags |
field |
duplicate_flags |
| minidoc.metrics.SourceMetricsData.file_id |
field |
file_id |
| minidoc.metrics.SourceMetricsData.file_path |
field |
file_path |
| minidoc.metrics.SourceMetricsData.halstead |
field |
halstead |
| minidoc.metrics.SourceMetricsData.normalized_lines |
field |
normalized_lines |
| minidoc.metrics.SourceMetricsData.physical_lines |
field |
physical_lines |
| minidoc.metrics.SourceMetricsData.source |
field |
source |
| minidoc.metrics.SourceMetricsData.source_lines |
field |
source_lines |
| minidoc.model.CallReference |
struct |
struct CallReference |
| minidoc.model.CallReference.caller_id |
field |
caller_id |
| minidoc.model.CallReference.dynamic |
field |
dynamic |
| minidoc.model.CallReference.file_id |
field |
file_id |
| minidoc.model.CallReference.namespace_name |
field |
namespace_name |
| minidoc.model.CallReference.package_name |
field |
package_name |
| minidoc.model.CallReference.position |
field |
position |
| minidoc.model.CallReference.raw_target |
field |
raw_target |
| minidoc.model.CloneGroup |
struct |
struct CloneGroup |
| minidoc.model.CloneGroup.fingerprint |
field |
fingerprint |
| minidoc.model.CloneGroup.line_count |
field |
line_count |
| minidoc.model.CloneGroup.occurrences |
field |
occurrences |
| minidoc.model.CloneOccurrence |
struct |
struct CloneOccurrence |
| minidoc.model.CloneOccurrence.file_id |
field |
file_id |
| minidoc.model.CloneOccurrence.file_path |
field |
file_path |
| minidoc.model.CloneOccurrence.line |
field |
line |
| minidoc.model.Config |
struct |
struct Config |
| minidoc.model.Config.check_only |
field |
check_only |
| minidoc.model.Config.config_file |
field |
config_file |
| minidoc.model.Config.contract_warnings |
field |
contract_warnings |
| minidoc.model.Config.defines |
field |
defines |
| minidoc.model.Config.dependency_mode |
field |
dependency_mode |
| minidoc.model.Config.duplicate_summary_threshold |
field |
duplicate_summary_threshold |
| minidoc.model.Config.entry |
field |
entry |
| minidoc.model.Config.excludes |
field |
excludes |
| minidoc.model.Config.formats |
field |
formats |
| minidoc.model.Config.graph_calls |
field |
graph_calls |
| minidoc.model.Config.graph_granularity |
field |
graph_granularity |
| minidoc.model.Config.graph_imports |
field |
graph_imports |
| minidoc.model.Config.graph_max_nodes |
field |
graph_max_nodes |
| minidoc.model.Config.graph_types |
field |
graph_types |
| minidoc.model.Config.hide_empty_graphs |
field |
hide_empty_graphs |
| minidoc.model.Config.html_out |
field |
html_out |
| minidoc.model.Config.include_dirs |
field |
include_dirs |
| minidoc.model.Config.include_generation_timestamp |
field |
include_generation_timestamp |
| minidoc.model.Config.include_internal |
field |
include_internal |
| minidoc.model.Config.keep_going |
field |
keep_going |
| minidoc.model.Config.markdown_out |
field |
markdown_out |
| minidoc.model.Config.markdown_profile |
field |
markdown_profile |
| minidoc.model.Config.project_description |
field |
project_description |
| minidoc.model.Config.project_file |
field |
project_file |
| minidoc.model.Config.project_name |
field |
project_name |
| minidoc.model.Config.reachable_only |
field |
reachable_only |
| minidoc.model.Config.repository |
field |
repository |
| minidoc.model.Config.repository_ref |
field |
repository_ref |
| minidoc.model.Config.source_revision |
field |
source_revision |
| minidoc.model.Config.source_roots |
field |
source_roots |
| minidoc.model.Config.strict |
field |
strict |
| minidoc.model.Config.summary_quality_warnings |
field |
summary_quality_warnings |
| minidoc.model.Config.target |
field |
target |
| minidoc.model.CoverageMetric |
struct |
struct CoverageMetric |
| minidoc.model.CoverageMetric.documented |
field |
documented |
| minidoc.model.CoverageMetric.percent |
field |
percent |
| minidoc.model.CoverageMetric.total |
field |
total |
| minidoc.model.defaultConfig |
function |
function defaultConfig() |
| minidoc.model.Diagnostic |
struct |
struct Diagnostic |
| minidoc.model.Diagnostic.code |
field |
code |
| minidoc.model.Diagnostic.column |
field |
column |
| minidoc.model.Diagnostic.file_path |
field |
file_path |
| minidoc.model.Diagnostic.line |
field |
line |
| minidoc.model.Diagnostic.message |
field |
message |
| minidoc.model.Diagnostic.severity |
field |
severity |
| minidoc.model.DocBlock |
struct |
struct DocBlock |
| minidoc.model.DocBlock.body |
field |
body |
| minidoc.model.DocBlock.details |
field |
details |
| minidoc.model.DocBlock.end_line |
field |
end_line |
| minidoc.model.DocBlock.end_pos |
field |
end_pos |
| minidoc.model.DocBlock.internal |
field |
internal |
| minidoc.model.DocBlock.start_line |
field |
start_line |
| minidoc.model.DocBlock.start_pos |
field |
start_pos |
| minidoc.model.DocBlock.summary |
field |
summary |
| minidoc.model.DocBlock.tags |
field |
tags |
| minidoc.model.DocBlock.target_kind |
field |
target_kind |
| minidoc.model.DocBlock.used |
field |
used |
| minidoc.model.DocTag |
struct |
struct DocTag |
| minidoc.model.DocTag.key |
field |
key |
| minidoc.model.DocTag.name |
field |
name |
| minidoc.model.DocTag.text |
field |
text |
| minidoc.model.DocumentationCoverage |
struct |
struct DocumentationCoverage |
| minidoc.model.DocumentationCoverage.api |
field |
api |
| minidoc.model.DocumentationCoverage.constants |
field |
constants |
| minidoc.model.DocumentationCoverage.enum_variants |
field |
enum_variants |
| minidoc.model.DocumentationCoverage.fields |
field |
fields |
| minidoc.model.DocumentationCoverage.globals |
field |
globals |
| minidoc.model.DocumentationCoverage.overall |
field |
overall |
| minidoc.model.DocumentationCoverage.parameters |
field |
parameters |
| minidoc.model.emptyDocBlock |
function |
function emptyDocBlock() |
| minidoc.model.emptyHalsteadMetrics |
function |
function emptyHalsteadMetrics() |
| minidoc.model.emptyProject |
function |
function emptyProject(config, root_dir) |
| minidoc.model.emptyProjectMetrics |
function |
function emptyProjectMetrics() |
| minidoc.model.FileDoc |
struct |
struct FileDoc |
| minidoc.model.FileDoc.details |
field |
details |
| minidoc.model.FileDoc.docs |
field |
docs |
| minidoc.model.FileDoc.id |
field |
id |
| minidoc.model.FileDoc.imports |
field |
imports |
| minidoc.model.FileDoc.package_name |
field |
package_name |
| minidoc.model.FileDoc.path |
field |
path |
| minidoc.model.FileDoc.processed_source |
field |
processed_source |
| minidoc.model.FileDoc.program |
field |
program |
| minidoc.model.FileDoc.reachable |
field |
reachable |
| minidoc.model.FileDoc.relative_path |
field |
relative_path |
| minidoc.model.FileDoc.source |
field |
source |
| minidoc.model.FileDoc.summary |
field |
summary |
| minidoc.model.FileDoc.symbol_ids |
field |
symbol_ids |
| minidoc.model.FileMetrics |
struct |
struct FileMetrics |
| minidoc.model.FileMetrics.average_cyclomatic_complexity |
field |
average_cyclomatic_complexity |
| minidoc.model.FileMetrics.blank_lines |
field |
blank_lines |
| minidoc.model.FileMetrics.cognitive_complexity |
field |
cognitive_complexity |
| minidoc.model.FileMetrics.comment_lines |
field |
comment_lines |
| minidoc.model.FileMetrics.cyclomatic_complexity |
field |
cyclomatic_complexity |
| minidoc.model.FileMetrics.duplicated_lines |
field |
duplicated_lines |
| minidoc.model.FileMetrics.duplication_percent |
field |
duplication_percent |
| minidoc.model.FileMetrics.file_id |
field |
file_id |
| minidoc.model.FileMetrics.file_path |
field |
file_path |
| minidoc.model.FileMetrics.function_count |
field |
function_count |
| minidoc.model.FileMetrics.halstead |
field |
halstead |
| minidoc.model.FileMetrics.maintainability_index |
field |
maintainability_index |
| minidoc.model.FileMetrics.maximum_cognitive_complexity |
field |
maximum_cognitive_complexity |
| minidoc.model.FileMetrics.maximum_cyclomatic_complexity |
field |
maximum_cyclomatic_complexity |
| minidoc.model.FileMetrics.physical_lines |
field |
physical_lines |
| minidoc.model.FileMetrics.source_lines |
field |
source_lines |
| minidoc.model.FileMetrics.statement_count |
field |
statement_count |
| minidoc.model.FunctionMetrics |
struct |
struct FunctionMetrics |
| minidoc.model.FunctionMetrics.cognitive_complexity |
field |
cognitive_complexity |
| minidoc.model.FunctionMetrics.cyclomatic_complexity |
field |
cyclomatic_complexity |
| minidoc.model.FunctionMetrics.file_id |
field |
file_id |
| minidoc.model.FunctionMetrics.file_path |
field |
file_path |
| minidoc.model.FunctionMetrics.halstead |
field |
halstead |
| minidoc.model.FunctionMetrics.line |
field |
line |
| minidoc.model.FunctionMetrics.lines_of_code |
field |
lines_of_code |
| minidoc.model.FunctionMetrics.maintainability_index |
field |
maintainability_index |
| minidoc.model.FunctionMetrics.maximum_nesting |
field |
maximum_nesting |
| minidoc.model.FunctionMetrics.parameter_count |
field |
parameter_count |
| minidoc.model.FunctionMetrics.qualified_name |
field |
qualified_name |
| minidoc.model.FunctionMetrics.statement_count |
field |
statement_count |
| minidoc.model.FunctionMetrics.symbol_id |
field |
symbol_id |
| minidoc.model.HalsteadMetrics |
struct |
struct HalsteadMetrics |
| minidoc.model.HalsteadMetrics.difficulty |
field |
difficulty |
| minidoc.model.HalsteadMetrics.distinct_operands |
field |
distinct_operands |
| minidoc.model.HalsteadMetrics.distinct_operators |
field |
distinct_operators |
| minidoc.model.HalsteadMetrics.effort |
field |
effort |
| minidoc.model.HalsteadMetrics.estimated_bugs |
field |
estimated_bugs |
| minidoc.model.HalsteadMetrics.length |
field |
length |
| minidoc.model.HalsteadMetrics.total_operands |
field |
total_operands |
| minidoc.model.HalsteadMetrics.total_operators |
field |
total_operators |
| minidoc.model.HalsteadMetrics.vocabulary |
field |
vocabulary |
| minidoc.model.HalsteadMetrics.volume |
field |
volume |
| minidoc.model.ImportDoc |
struct |
struct ImportDoc |
| minidoc.model.ImportDoc.alias |
field |
alias |
| minidoc.model.ImportDoc.module_name |
field |
module_name |
| minidoc.model.ImportDoc.position |
field |
position |
| minidoc.model.ImportDoc.request |
field |
request |
| minidoc.model.ImportDoc.resolved_path |
field |
resolved_path |
| minidoc.model.ImportDoc.source_file_id |
field |
source_file_id |
| minidoc.model.ImportDoc.target_file_id |
field |
target_file_id |
| minidoc.model.newDiagnostic |
function |
function newDiagnostic(severity, code, file_path, line, column, message) |
| minidoc.model.ParameterDoc |
struct |
struct ParameterDoc |
| minidoc.model.ParameterDoc.default_value |
field |
default_value |
| minidoc.model.ParameterDoc.description |
field |
description |
| minidoc.model.ParameterDoc.name |
field |
name |
| minidoc.model.ParameterDoc.optional |
field |
optional |
| minidoc.model.ParameterDoc.type_name |
field |
type_name |
| minidoc.model.ParameterDoc.variadic |
field |
variadic |
| minidoc.model.ProjectDoc |
struct |
struct ProjectDoc |
| minidoc.model.ProjectDoc.call_references |
field |
call_references |
| minidoc.model.ProjectDoc.complete |
field |
complete |
| minidoc.model.ProjectDoc.config |
field |
config |
| minidoc.model.ProjectDoc.diagnostics |
field |
diagnostics |
| minidoc.model.ProjectDoc.files |
field |
files |
| minidoc.model.ProjectDoc.generated_at |
field |
generated_at |
| minidoc.model.ProjectDoc.generator_version |
field |
generator_version |
| minidoc.model.ProjectDoc.metrics |
field |
metrics |
| minidoc.model.ProjectDoc.relations |
field |
relations |
| minidoc.model.ProjectDoc.root_dir |
field |
root_dir |
| minidoc.model.ProjectDoc.source_revision |
field |
source_revision |
| minidoc.model.ProjectDoc.symbols |
field |
symbols |
| minidoc.model.ProjectMetrics |
struct |
struct ProjectMetrics |
| minidoc.model.ProjectMetrics.average_cyclomatic_complexity |
field |
average_cyclomatic_complexity |
| minidoc.model.ProjectMetrics.blank_lines |
field |
blank_lines |
| minidoc.model.ProjectMetrics.clone_group_count |
field |
clone_group_count |
| minidoc.model.ProjectMetrics.clone_groups |
field |
clone_groups |
| minidoc.model.ProjectMetrics.cognitive_complexity |
field |
cognitive_complexity |
| minidoc.model.ProjectMetrics.comment_lines |
field |
comment_lines |
| minidoc.model.ProjectMetrics.cyclomatic_complexity |
field |
cyclomatic_complexity |
| minidoc.model.ProjectMetrics.documentable_symbols |
field |
documentable_symbols |
| minidoc.model.ProjectMetrics.documentation |
field |
documentation |
| minidoc.model.ProjectMetrics.documentation_coverage |
field |
documentation_coverage |
| minidoc.model.ProjectMetrics.documented_symbols |
field |
documented_symbols |
| minidoc.model.ProjectMetrics.duplicate_window_size |
field |
duplicate_window_size |
| minidoc.model.ProjectMetrics.duplicated_lines |
field |
duplicated_lines |
| minidoc.model.ProjectMetrics.duplication_percent |
field |
duplication_percent |
| minidoc.model.ProjectMetrics.file_count |
field |
file_count |
| minidoc.model.ProjectMetrics.file_metrics |
field |
file_metrics |
| minidoc.model.ProjectMetrics.function_count |
field |
function_count |
| minidoc.model.ProjectMetrics.function_metrics |
field |
function_metrics |
| minidoc.model.ProjectMetrics.halstead |
field |
halstead |
| minidoc.model.ProjectMetrics.maintainability_index |
field |
maintainability_index |
| minidoc.model.ProjectMetrics.maximum_cognitive_complexity |
field |
maximum_cognitive_complexity |
| minidoc.model.ProjectMetrics.maximum_cyclomatic_complexity |
field |
maximum_cyclomatic_complexity |
| minidoc.model.ProjectMetrics.physical_lines |
field |
physical_lines |
| minidoc.model.ProjectMetrics.source_lines |
field |
source_lines |
| minidoc.model.ProjectMetrics.statement_count |
field |
statement_count |
| minidoc.model.RelationDoc |
struct |
struct RelationDoc |
| minidoc.model.RelationDoc.certainty |
field |
certainty |
| minidoc.model.RelationDoc.from_id |
field |
from_id |
| minidoc.model.RelationDoc.kind |
field |
kind |
| minidoc.model.RelationDoc.label |
field |
label |
| minidoc.model.RelationDoc.to_id |
field |
to_id |
| minidoc.model.SymbolDoc |
struct |
struct SymbolDoc |
| minidoc.model.SymbolDoc.column |
field |
column |
| minidoc.model.SymbolDoc.container_id |
field |
container_id |
| minidoc.model.SymbolDoc.deprecated |
field |
deprecated |
| minidoc.model.SymbolDoc.details |
field |
details |
| minidoc.model.SymbolDoc.file_id |
field |
file_id |
| minidoc.model.SymbolDoc.file_path |
field |
file_path |
| minidoc.model.SymbolDoc.id |
field |
id |
| minidoc.model.SymbolDoc.internal |
field |
internal |
| minidoc.model.SymbolDoc.kind |
field |
kind |
| minidoc.model.SymbolDoc.line |
field |
line |
| minidoc.model.SymbolDoc.modifiers |
field |
modifiers |
| minidoc.model.SymbolDoc.name |
field |
name |
| minidoc.model.SymbolDoc.namespace_name |
field |
namespace_name |
| minidoc.model.SymbolDoc.package_name |
field |
package_name |
| minidoc.model.SymbolDoc.parameters |
field |
parameters |
| minidoc.model.SymbolDoc.position |
field |
position |
| minidoc.model.SymbolDoc.qualified_name |
field |
qualified_name |
| minidoc.model.SymbolDoc.return_type |
field |
return_type |
| minidoc.model.SymbolDoc.signature |
field |
signature |
| minidoc.model.SymbolDoc.source_url |
field |
source_url |
| minidoc.model.SymbolDoc.summary |
field |
summary |
| minidoc.model.SymbolDoc.tags |
field |
tags |
| minidoc.model.SymbolDoc.type_name |
field |
type_name |
| minidoc.ordering._entityName |
function |
function _entityName(project, id) |
| minidoc.ordering._sortCloneGroups |
function |
function _sortCloneGroups(values) |
| minidoc.ordering._sortDiagnostics |
function |
function _sortDiagnostics(values) |
| minidoc.ordering._sortFileMetrics |
function |
function _sortFileMetrics(values) |
| minidoc.ordering._sortFiles |
function |
function _sortFiles(values) |
| minidoc.ordering._sortFunctionMetrics |
function |
function _sortFunctionMetrics(values) |
| minidoc.ordering._sortImports |
function |
function _sortImports(values) |
| minidoc.ordering._sortOccurrences |
function |
function _sortOccurrences(values) |
| minidoc.ordering._sortRelations |
function |
function _sortRelations(project, values) |
| minidoc.ordering._sortSymbols |
function |
function _sortSymbols(values) |
| minidoc.ordering._sortWithKeys |
function |
function _sortWithKeys(values, keys) |
| minidoc.ordering.apply |
function |
function apply(project) |
| minidoc.ordering.SortItem |
struct |
struct SortItem |
| minidoc.ordering.SortItem.key |
field |
key |
| minidoc.ordering.SortItem.value |
field |
value |
| minidoc.render_html._css |
function |
function _css() |
| minidoc.render_html._dependencies |
function |
function _dependencies(project) |
| minidoc.render_html._dependencyReferenceCount |
function |
function _dependencyReferenceCount(project, dependency_id) |
| minidoc.render_html._diagnostics |
function |
function _diagnostics(project) |
| minidoc.render_html._file |
function |
function _file(project, file) |
| minidoc.render_html._fileById |
function |
function _fileById(project, id) |
| minidoc.render_html._filePage |
function |
function _filePage(file) |
| minidoc.render_html._files |
function |
function _files(project) |
| minidoc.render_html._fileVisible |
function |
function _fileVisible(project, file) |
| minidoc.render_html._graphEnabled |
function |
function _graphEnabled(project, relation_kind, configured) |
| minidoc.render_html._graphPage |
function |
function _graphPage(project, title, filename, description) |
| minidoc.render_html._hasDependencies |
function |
function _hasDependencies(project) |
| minidoc.render_html._home |
function |
function _home(project) |
| minidoc.render_html._isType |
function |
function _isType(doc_symbol) |
| minidoc.render_html._javascript |
function |
function _javascript() |
| minidoc.render_html._layout |
function |
function _layout(project, title, content) |
| minidoc.render_html._markdownHtml |
function |
function _markdownHtml(text) |
| minidoc.render_html._metrics |
function |
function _metrics(project) |
| minidoc.render_html._ownerType |
function |
function _ownerType(project, doc_symbol) |
| minidoc.render_html._package |
function |
function _package(project, package_name) |
| minidoc.render_html._packagePage |
function |
function _packagePage(name) |
| minidoc.render_html._packages |
function |
function _packages(project) |
| minidoc.render_html._packagesIndex |
function |
function _packagesIndex(project) |
| minidoc.render_html._projectDescription |
function |
function _projectDescription(project) |
| minidoc.render_html._searchIndex |
function |
function _searchIndex(project) |
| minidoc.render_html._shortRevision |
function |
function _shortRevision(value) |
| minidoc.render_html._sortTags |
function |
function _sortTags(tags) |
| minidoc.render_html._symbolById |
function |
function _symbolById(project, id) |
| minidoc.render_html._symbolFixtureRole |
function |
function _symbolFixtureRole(doc_symbol) |
| minidoc.render_html._symbolHasTag |
function |
function _symbolHasTag(doc_symbol, name) |
| minidoc.render_html._symbolHtml |
function |
function _symbolHtml(project, doc_symbol, heading) |
| minidoc.render_html._symbolLink |
function |
function _symbolLink(project, doc_symbol) |
| minidoc.render_html._symbols |
function |
function _symbols(project) |
| minidoc.render_html._symbolTagKeys |
function |
function _symbolTagKeys(doc_symbol, name) |
| minidoc.render_html._tagValue |
function |
function _tagValue(doc_symbol, name) |
| minidoc.render_html._tests |
function |
function _tests(project) |
| minidoc.render_html._type |
function |
function _type(project, type_symbol) |
| minidoc.render_html._typePage |
function |
function _typePage(doc_symbol) |
| minidoc.render_html._visible |
function |
function _visible(project, doc_symbol) |
| minidoc.render_html._writeGenerated |
function |
function _writeGenerated(root, generated, relative_path, content) |
| minidoc.render_html.render |
function |
function render(project) |
| minidoc.render_markdown._appendSymbol |
function |
function _appendSymbol(writer, project, doc_symbol, heading_level) |
| minidoc.render_markdown._appendTagSections |
function |
function _appendTagSections(writer, doc_symbol) |
| minidoc.render_markdown._dependencyReferenceCount |
function |
function _dependencyReferenceCount(project, dependency_id) |
| minidoc.render_markdown._fileById |
function |
function _fileById(project, id) |
| minidoc.render_markdown._filePage |
function |
function _filePage(file) |
| minidoc.render_markdown._fileVisible |
function |
function _fileVisible(project, file) |
| minidoc.render_markdown._graphEnabled |
function |
function _graphEnabled(project, relation_kind, configured) |
| minidoc.render_markdown._hasDependencies |
function |
function _hasDependencies(project) |
| minidoc.render_markdown._homeName |
function |
function _homeName(project) |
| minidoc.render_markdown._indentedCode |
function |
function _indentedCode(text) |
| minidoc.render_markdown._isType |
function |
function _isType(doc_symbol) |
| minidoc.render_markdown._ownerType |
function |
function _ownerType(project, doc_symbol) |
| minidoc.render_markdown._packagePage |
function |
function _packagePage(name) |
| minidoc.render_markdown._packages |
function |
function _packages(project) |
| minidoc.render_markdown._projectDescription |
function |
function _projectDescription(project) |
| minidoc.render_markdown._renderDependencies |
function |
function _renderDependencies(project) |
| minidoc.render_markdown._renderDiagnostics |
function |
function _renderDiagnostics(project) |
| minidoc.render_markdown._renderFile |
function |
function _renderFile(project, file) |
| minidoc.render_markdown._renderFiles |
function |
function _renderFiles(project) |
| minidoc.render_markdown._renderGraphPage |
function |
function _renderGraphPage(project, title, image_name, description) |
| minidoc.render_markdown._renderHome |
function |
function _renderHome(project) |
| minidoc.render_markdown._renderMetrics |
function |
function _renderMetrics(project) |
| minidoc.render_markdown._renderPackage |
function |
function _renderPackage(project, package_name) |
| minidoc.render_markdown._renderPackagesIndex |
function |
function _renderPackagesIndex(project) |
| minidoc.render_markdown._renderSidebar |
function |
function _renderSidebar(project) |
| minidoc.render_markdown._renderSymbols |
function |
function _renderSymbols(project) |
| minidoc.render_markdown._renderTests |
function |
function _renderTests(project) |
| minidoc.render_markdown._renderType |
function |
function _renderType(project, type_symbol) |
| minidoc.render_markdown._shortRevision |
function |
function _shortRevision(value) |
| minidoc.render_markdown._sortTags |
function |
function _sortTags(tags) |
| minidoc.render_markdown._symbolById |
function |
function _symbolById(project, id) |
| minidoc.render_markdown._symbolFixtureRole |
function |
function _symbolFixtureRole(doc_symbol) |
| minidoc.render_markdown._symbolHasTag |
function |
function _symbolHasTag(doc_symbol, name) |
| minidoc.render_markdown._symbolLink |
function |
function _symbolLink(project, doc_symbol) |
| minidoc.render_markdown._symbolTagKeys |
function |
function _symbolTagKeys(doc_symbol, name) |
| minidoc.render_markdown._typePage |
function |
function _typePage(doc_symbol) |
| minidoc.render_markdown._visible |
function |
function _visible(project, doc_symbol) |
| minidoc.render_markdown._writeGenerated |
function |
function _writeGenerated(root, generated, relative_path, content) |
| minidoc.render_markdown.render |
function |
function render(project) |
| minidoc.util._gitDirectory |
function |
function _gitDirectory(root) |
| minidoc.util._optionalText |
function |
function _optionalText(path) |
| minidoc.util._packedRevision |
function |
function _packedRevision(path, reference) |
| minidoc.util._stringLess |
function |
function _stringLess(left, right) |
| minidoc.util.absolutePath |
function |
function absolutePath(path, base) |
| minidoc.util.addUnique |
function |
function addUnique(values, value) |
| minidoc.util.alphabeticalLess |
function |
function alphabeticalLess(left, right) |
| minidoc.util.containsString |
function |
function containsString(values, value) |
| minidoc.util.currentDirectory |
function |
function currentDirectory() |
| minidoc.util.directoryName |
function |
function directoryName(path) |
| minidoc.util.ensureDirectory |
function |
function ensureDirectory(path) |
| minidoc.util.fileName |
function |
function fileName(path) |
| minidoc.util.gitRevision |
function |
function gitRevision(root) |
| minidoc.util.hashText |
function |
function hashText(value) |
| minidoc.util.htmlEscape |
function |
function htmlEscape(value) |
| minidoc.util.isAbsolute |
function |
function isAbsolute(path) |
| minidoc.util.isProjectSource |
function |
function isProjectSource(path, entry, source_roots) |
| minidoc.util.isSafeUrl |
function |
function isSafeUrl(value) |
| minidoc.util.isWhitespaceChar |
function |
function isWhitespaceChar(ch) |
| minidoc.util.joinPath |
function |
function joinPath(left, right) |
| minidoc.util.jsonEscape |
function |
function jsonEscape(value) |
| minidoc.util.lineAndColumn |
function |
function lineAndColumn(source, position) |
| minidoc.util.markdownTableEscape |
function |
function markdownTableEscape(value) |
| minidoc.util.normalizePath |
function |
function normalizePath(path) |
| minidoc.util.onlyWhitespace |
function |
function onlyWhitespace(source, start_pos, end_pos) |
| minidoc.util.pathKey |
function |
function pathKey(path) |
| minidoc.util.pathsEqual |
function |
function pathsEqual(left, right) |
| minidoc.util.readText |
function |
function readText(path) |
| minidoc.util.relativePath |
function |
function relativePath(base, target) |
| minidoc.util.removeStaleGenerated |
function |
function removeStaleGenerated(root, generated) |
| minidoc.util.replaceSlashes |
function |
function replaceSlashes(value) |
| minidoc.util.slug |
function |
function slug(value) |
| minidoc.util.sortedStrings |
function |
function sortedStrings(values) |
| minidoc.util.sourceUrl |
function |
function sourceUrl(repository, ref_name, relative_path, line) |
| minidoc.util.stableSlug |
function |
function stableSlug(value) |
| minidoc.util.stem |
function |
function stem(path) |
| minidoc.util.writeText |
function |
function writeText(path, text) |