private void attachDeprecatedNode(DocumentableNode documentableNode) { if (!deprecatedAttachmentStack.empty()) { documentableNode.addDeprecatedAttachment(deprecatedAttachmentStack.pop()); } }
private void attachMarkdownDocumentations(DocumentableNode documentableNode) { if (!markdownDocumentationStack.empty()) { documentableNode.setMarkdownDocumentationAttachment(markdownDocumentationStack.pop()); } }
private void validateNoParameters(DocumentableNode documentableNode) { BLangMarkdownDocumentation documentation = documentableNode.getMarkdownDocumentationAttachment(); if (documentation == null) { return; } Map<String, BLangMarkdownParameterDocumentation> parameterDocumentations = documentation.getParameterDocumentations(); if (parameterDocumentations.isEmpty()) { return; } parameterDocumentations.forEach((parameter, parameterDocumentation) -> dlog.warning(parameterDocumentation.pos, DiagnosticCode.NO_SUCH_DOCUMENTABLE_PARAMETER, parameter)); }
private void validateReturnParameter(DocumentableNode documentableNode, BLangNode node, boolean isExpected) { BLangMarkdownDocumentation documentationAttachment = documentableNode.getMarkdownDocumentationAttachment(); if (documentationAttachment == null) { return; } BLangMarkdownReturnParameterDocumentation returnParameter = documentationAttachment.getReturnParameter(); if (returnParameter == null && isExpected) { dlog.warning(node.pos, DiagnosticCode.UNDOCUMENTED_RETURN_PARAMETER); } else if (returnParameter != null && !isExpected) { dlog.warning(returnParameter.pos, DiagnosticCode.NO_DOCUMENTABLE_RETURN_PARAMETER); } else if (returnParameter != null) { returnParameter.setReturnType(((BLangFunction) node).getReturnTypeNode().type); } } }
DiagnosticCode undocumentedParameter, DiagnosticCode noSuchParameter, DiagnosticCode parameterAlreadyDefined) { BLangMarkdownDocumentation documentation = documentableNode.getMarkdownDocumentationAttachment(); if (documentation == null) { return;