Commits

Tero Koskinen committed 1bd5173

Clarify who owns the object when an object is added to the collection.

Also, do some minor formatting fixes.

Comments (0)

Files changed (1)

doc/manual/en/source/api-ahven-results.rst

 
    type Result_Info is private;
 
+A type which holds a test result for one test.
+
 
 Result_Collection
 '''''''''''''''''
 
    type Result_Collection_Access is access Result_Collection;
 
+Access type for Result_Collection.
+
 
 
 Result_Info_Cursor
 
    procedure Set_Test_Name (Info : in out Result_Info; Name : String);
 
-A helper function, which calls Set_Test_Name (.. ; Bounded_String)
+A helper function, which calls Set_Test_Name (.. ; Bounded_String).
 
 Set_Routine_Name
 ''''''''''''''''
 
    procedure Set_Routine_Name (Info : in out Result_Info; Name : String);
 
-A helper function, which calls Set_Routine_Name (.. ; Bounded_String)
+A helper function, which calls Set_Routine_Name (.. ; Bounded_String).
 
 Set_Message
 '''''''''''
 
    procedure Set_Message (Info : in out Result_Info; Message : String);
 
-A helper function, which calls Set_Message (.. ; Bounded_String)
+A helper function, which calls Set_Message (.. ; Bounded_String).
 
 Set_Long_Message
 ''''''''''''''''
    procedure Set_Long_Message (Info    : in out Result_Info;
                                Message :        Bounded_String);
 
-Set a long message for the result
+Set a long message for the result.
 
 Set_Long_Message
 ''''''''''''''''
 
    procedure Set_Long_Message (Info : in out Result_Info; Message : String);
 
-A helper function, which calls Set_Long_Message (.. ; Bounded_String)
+A helper function, which calls Set_Long_Message (.. ; Bounded_String).
 
 Set_Execution_Time
 ''''''''''''''''''
 
    function Get_Message (Info : Result_Info) return String;
 
-Return the message of the result info.
+Return the message of the result info. The message will
+be something what has been given to the Assert call.
 
 Get_Long_Message
 ''''''''''''''''
    function Get_Long_Message (Info : Result_Info) return String;
 
 Return the long message of the result info.
+The long message usually contains the backtrace or other info
+related to the test failure.
 
 Get_Execution_Time
 ''''''''''''''''''
                         Child      :        Result_Collection_Access);
 
 Add a child collection to the collection.
+Ownership of Child is transferred to the Collection container
+and Child will be automatically freed when Collection is destroyed.
 
 Add_Error
 '''''''''