mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
c20f3db09e
Under parameter doc comment list items, allow function doc comment syntax to nest so you can document the meaning of closure parameters' signatures. rdar://problem/24794725
87 lines
2.3 KiB
C++
87 lines
2.3 KiB
C++
//===--- Comment.h - Swift-specific comment parsing -------------*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See http://swift.org/LICENSE.txt for license information
|
|
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_AST_COMMENT_H
|
|
#define SWIFT_AST_COMMENT_H
|
|
|
|
#include "swift/Markup/Markup.h"
|
|
#include "llvm/ADT/Optional.h"
|
|
|
|
namespace swift {
|
|
class Decl;
|
|
class DocComment;
|
|
struct RawComment;
|
|
|
|
class DocComment {
|
|
const Decl *D;
|
|
const swift::markup::Document *Doc = nullptr;
|
|
const swift::markup::CommentParts Parts;
|
|
|
|
public:
|
|
DocComment(const Decl *D, swift::markup::Document *Doc,
|
|
swift::markup::CommentParts Parts)
|
|
: D(D), Doc(Doc), Parts(Parts) {}
|
|
|
|
const Decl *getDecl() const { return D; }
|
|
|
|
const swift::markup::Document *getDocument() const { return Doc; }
|
|
|
|
swift::markup::CommentParts getParts() const {
|
|
return Parts;
|
|
}
|
|
|
|
Optional<const swift::markup::Paragraph *> getBrief() const {
|
|
return Parts.Brief;
|
|
}
|
|
|
|
Optional<const swift::markup::ReturnsField * >getReturnsField() const {
|
|
return Parts.ReturnsField;
|
|
}
|
|
|
|
Optional<const swift::markup::ThrowsField*> getThrowsField() const {
|
|
return Parts.ThrowsField;
|
|
}
|
|
|
|
ArrayRef<const swift::markup::ParamField *> getParamFields() const {
|
|
return Parts.ParamFields;
|
|
}
|
|
|
|
ArrayRef<const swift::markup::MarkupASTNode *> getBodyNodes() const {
|
|
return Parts.BodyNodes;
|
|
}
|
|
|
|
bool isEmpty() const {
|
|
return Parts.isEmpty();
|
|
}
|
|
|
|
// Only allow allocation using the allocator in MarkupContext or by
|
|
// placement new.
|
|
void *operator new(size_t Bytes, swift::markup::MarkupContext &MC,
|
|
unsigned Alignment = alignof(DocComment));
|
|
void *operator new(size_t Bytes, void *Mem) {
|
|
assert(Mem);
|
|
return Mem;
|
|
}
|
|
|
|
// Make vanilla new/delete illegal.
|
|
void *operator new(size_t Bytes) = delete;
|
|
void operator delete(void *Data) = delete;
|
|
};
|
|
|
|
Optional<DocComment *>getDocComment(swift::markup::MarkupContext &Context,
|
|
const Decl *D);
|
|
|
|
} // namespace swift
|
|
|
|
#endif // LLVM_SWIFT_AST_COMMENT_H
|
|
|