7 Commits

Author	SHA1	Message	Date
David Farler	c20f3db09e	Nesting parameter/returns/throws doc comments for closure parameters ... 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	2016-04-10 15:32:07 -07:00
David Farler	a9297eed9f	Rename llvm::markup namespace to swift::markup ... This was naming was cargoed from long ago and this functionality isn't directly related to LLVM, it's specific to Swift.	2016-04-10 13:46:25 -07:00
David Farler	5eb479a6f2	Refactor: extractCommentParts can theoretically work for any markup AST node	2016-04-10 13:36:08 -07:00
Zach Panzarino	e3a4147ac9	Update copyright date	2015-12-31 23:28:40 +00:00
Ben Langmuir	409010741e	Fix leak in getDocComment() ... We were storing SmallVectors inside the MarkupContext. Also driveby add 'static' to a function. rdar://problem/22387897 Swift SVN r31562	2015-08-28 22:42:50 +00:00
David Farler	dd44dad017	Add 'throws' keyword to doc comments ... Adding the following to a doc comment: - throws: ... Will create a description about what/when the function will throw. This should be a peer to "- returns:" and "- parameter:" and not appear inline in the description. rdar://problem/21621679 Swift SVN r29831	2015-07-01 02:03:25 +00:00
David Farler	ca5876a866	swiftMarkup Library ... Replace ReST-flavored documentation comments with Markdown. rdar://problem/20180412 In addition to full Markdown support, the following extensions are supported. These appear as lists at the top level of the comment's "document". All of these extensions are matched without regard to case. Parameter Outlines ------------------ - Parameters: - x: ... - y: ... Separate Parameters ------------------- - parameter x: ... - parameter y: ... - Note: Parameter documentation may be broken up across the entire comment, with a mix of parameter documentation kinds - they'll be consolidated in the end. Returns ------- - returns: ... The following extensions are also list items at the top level, which will also appear in Xcode QuickHelp as first-class citizens: - Attention: ... - Author: ... - Authors: ... - Bug: ... - Complexity: ... - Copyright: ... - Date: ... - Experiment: ... - Important: ... - Invariant: ... - Note: ... - Postcondition: ... - Precondition: ... - Remark: ... - Remarks: ... - See: ... - Since: ... - Todo: ... - Version: ... - Warning: ... These match most of the extra fields in Doxygen, plus a few more per request. Other changes ------------- - Remove use of rawHTML for all markup AST nodes except for those not representable by the Xcode QuickHelp XSLT - <h>, <hr/>, and of course inline/block HTML itself. - Update the doc comment RNG schema to more accurately reflect Xcode QuickHelp. - Clean up cmark CMake configuration. - Rename "FullComment" to "DocComment" - Update the Swift Standard Documentation (in a follow-up commit) - Update SourceKit for minor changes and link against cmark (in a follow-up commit). Swift SVN r27727	2015-04-26 00:07:15 +00:00