From 75c1b8f927f927489d1cd9263834947666179532 Mon Sep 17 00:00:00 2001 From: JinShil Date: Sat, 27 Jan 2018 09:59:37 +0900 Subject: [PATCH] Wordsmithing style guide's doc comments --- dstyle.dd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dstyle.dd b/dstyle.dd index 6706e834e6..fc94997889 100644 --- a/dstyle.dd +++ b/dstyle.dd @@ -396,7 +396,7 @@ class MyClass ) $(LISTSECTION phobos_documentation, Documentation, - $(LI Every public symbol be exposed on the documentation:) + $(LI Every public symbol should be exposed in the documentation:) --- /// A public symbol enum myFancyConstant; @@ -420,7 +420,7 @@ bool isPositive(int number) return number > 0; } --- - $(LI Text in sections (e.g. `Params:`, `Returns:`, `See_Also`) should be indented by one level if spans more than the line of the section.) + $(LI Text in sections (e.g. `Params:`, `Returns:`, `See_Also`) should be indented by one level if it spans more than the line of the section.) $(LI Documentation comments should not use more than two stars `/**` in the header line.) $(LI Block comments (`/**`) should be used - not nesting block comments (`/++`)) $(LI Global functions shouldn't indent their documentation block nor use stars as indentation.)