[multiple changes]

2012-08-06  Vincent Pucci  <pucci@adacore.com>

	* s-atopri.adb: Minor reformatting.

2012-08-06  Arnaud Charlet  <charlet@adacore.com>

	* gnat-style.texi: Clarify that all subprograms should be
	documented. Minor rewording.

From-SVN: r190160
This commit is contained in:
Arnaud Charlet 2012-08-06 09:54:34 +02:00
parent f2c992d906
commit b5ee491c7b
3 changed files with 25 additions and 13 deletions

View File

@ -1,3 +1,12 @@
2012-08-06 Vincent Pucci <pucci@adacore.com>
* s-atopri.adb: Minor reformatting.
2012-08-06 Arnaud Charlet <charlet@adacore.com>
* gnat-style.texi: Clarify that all subprograms should be
documented. Minor rewording.
2012-08-06 Robert Dewar <dewar@adacore.com> 2012-08-06 Robert Dewar <dewar@adacore.com>
* aspects.ads: Define Aspect_Id_Exclude_No_Aspect. * aspects.ads: Define Aspect_Id_Exclude_No_Aspect.

View File

@ -351,8 +351,8 @@ Local names can be shorter, because they are used only within
one context, where comments explain their purpose. one context, where comments explain their purpose.
@item @item
When starting a default expression on the line that follows the declaration When starting an initialization or default expression on the line that follows
line, use 2 characters for indentation. the declaration line, use 2 characters for indentation.
@smallexample @c adanocomment @smallexample @c adanocomment
Entity1 : Integer := Entity1 : Integer :=
@ -360,12 +360,12 @@ line, use 2 characters for indentation.
@end smallexample @end smallexample
@item @item
If a default expression needs to be continued on subsequent lines, the If an initialization or default expression needs to be continued on subsequent
continuations should be indented from the start of the expression. lines, the continuations should be indented from the start of the expression.
@smallexample @c adanocomment @smallexample @c adanocomment
Entity1 : Integer := Long_Function_Name Entity1 : Integer := Long_Function_Name
(parameters for call); (parameters for call);
@end smallexample @end smallexample
@end itemize @end itemize
@ -738,7 +738,10 @@ also be used as headers for sections of comments, or collections
of declarations that are related. of declarations that are related.
@item @item
Every subprogram body must have a preceding @syntax{subprogram_declaration}. Every subprogram body must have a preceding @syntax{subprogram_declaration},
which includes proper client documentation so that you do not need to
read the subprogram body in order to understand what the subprogram does and
how to call it. All subprograms should be documented, without exceptions.
@item @item
@cindex Blank lines (in subprogram bodies) @cindex Blank lines (in subprogram bodies)

View File

@ -44,9 +44,9 @@ package body System.Atomic_Primitives is
end if; end if;
end Lock_Free_Read_8; end Lock_Free_Read_8;
---------------------- -----------------------
-- Lock_Free_Read_16 -- -- Lock_Free_Read_16 --
---------------------- -----------------------
function Lock_Free_Read_16 (Ptr : Address) return uint16 is function Lock_Free_Read_16 (Ptr : Address) return uint16 is
begin begin
@ -57,9 +57,9 @@ package body System.Atomic_Primitives is
end if; end if;
end Lock_Free_Read_16; end Lock_Free_Read_16;
---------------------- -----------------------
-- Lock_Free_Read_32 -- -- Lock_Free_Read_32 --
---------------------- -----------------------
function Lock_Free_Read_32 (Ptr : Address) return uint32 is function Lock_Free_Read_32 (Ptr : Address) return uint32 is
begin begin
@ -70,9 +70,9 @@ package body System.Atomic_Primitives is
end if; end if;
end Lock_Free_Read_32; end Lock_Free_Read_32;
---------------------- -----------------------
-- Lock_Free_Read_64 -- -- Lock_Free_Read_64 --
---------------------- -----------------------
function Lock_Free_Read_64 (Ptr : Address) return uint64 is function Lock_Free_Read_64 (Ptr : Address) return uint64 is
begin begin