[docs][methods][2/n] add immediate object example

This demonstrates the use by explicit references and use by
requirements. It also shows that unused methods can coexist with unused
values.

Author: fantazio

check/classic/classic.exp

@@ -25,6 +25,8 @@
 ./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:3: goodbye
 ./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:4: world
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:3: internally_used
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:38: internally_used_f
@@ -146,6 +148,9 @@ Nothing else to report in this section
 
 .> UNUSED METHODS:
 =================
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused
 

check/classic/classic.ref

@@ -26,6 +26,8 @@
 ./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:3: goodbye
 ./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:4: world
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:3: internally_used
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:38: internally_used_f
@@ -147,6 +149,9 @@ Nothing else to report in this section
 
 .> UNUSED METHODS:
 =================
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused
 
@@ -617,7 +622,7 @@ Nothing else to report in this section
 --------------------------------------------------------------------------------
 
 
-Total: 531
-Success: 530
+Total: 534
+Success: 533
 Failed: 1
-Ratio: 99.8116760829%
+Ratio: 99.8127340824%

check/internal/internal.exp

@@ -15,6 +15,8 @@
 
 ./examples/docs/exported_values/code_constructs/module/module_lib.mli:6: M.unused
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused
 
@@ -101,6 +103,9 @@ Nothing else to report in this section
 
 .> UNUSED METHODS:
 =================
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused
 

check/internal/internal.ref

@@ -16,6 +16,8 @@
 
 ./examples/docs/exported_values/code_constructs/module/module_lib.mli:6: M.unused
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused
 
@@ -102,6 +104,9 @@ Nothing else to report in this section
 
 .> UNUSED METHODS:
 =================
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused
 
@@ -572,7 +577,7 @@ Nothing else to report in this section
 --------------------------------------------------------------------------------
 
 
-Total: 489
-Success: 488
+Total: 492
+Success: 491
 Failed: 1
-Ratio: 99.7955010225%
+Ratio: 99.7967479675%

check/threshold-1/threshold-1.exp

@@ -15,6 +15,8 @@
 
 ./examples/docs/exported_values/code_constructs/module/module_lib.mli:6: M.unused
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused
 
@@ -131,6 +133,9 @@
 ./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:2: hello
 ./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:3: goodbye
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:6: push_n_times
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:12: clear_stack
+
 ./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed.mli:1: mark_used
 ./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed_lib.mli:1: mark_used
 ./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed_no_intf.mli:1: mark_used
@@ -336,6 +341,9 @@ Nothing else to report in this section
 
 .> UNUSED METHODS:
 =================
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused
 
@@ -396,6 +404,10 @@ Nothing else to report in this section
 
 .>->  ALMOST UNUSED METHODS: Called 1 time(s):
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#peek
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#pop
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#push
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#externally_used
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#internally_used
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#externally_used

check/threshold-1/threshold-1.ref

@@ -16,6 +16,8 @@
 
 ./examples/docs/exported_values/code_constructs/module/module_lib.mli:6: M.unused
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused
 
@@ -135,6 +137,9 @@
 ./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:2: hello
 ./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:3: goodbye
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:6: push_n_times
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:12: clear_stack
+
 ./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed.mli:1: mark_used
 ./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed_lib.mli:1: mark_used
 ./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed_no_intf.mli:1: mark_used
@@ -340,6 +345,9 @@ Nothing else to report in this section
 
 .> UNUSED METHODS:
 =================
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused
 
@@ -400,6 +408,10 @@ Nothing else to report in this section
 
 .>->  ALMOST UNUSED METHODS: Called 1 time(s):
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#peek
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#pop
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#push
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#externally_used
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#internally_used
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#externally_used
@@ -950,7 +962,7 @@ Nothing else to report in this section
 --------------------------------------------------------------------------------
 
 
-Total: 821
-Success: 817
+Total: 829
+Success: 825
 Failed: 4
-Ratio: 99.5127892814%
+Ratio: 99.517490953%

check/threshold-3-0.5/threshold-3-0.5.exp

@@ -15,6 +15,8 @@
 
 ./examples/docs/exported_values/code_constructs/module/module_lib.mli:6: M.unused
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused
 
@@ -131,6 +133,9 @@
 ./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:2: hello
 ./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:3: goodbye
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:6: push_n_times
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:12: clear_stack
+
 ./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed.mli:1: mark_used
 ./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed_lib.mli:1: mark_used
 ./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed_no_intf.mli:1: mark_used
@@ -345,6 +350,8 @@
 ./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:4: world
 ./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:4: world
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:2: used
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:31: exported_f
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:38: internally_used_f
@@ -471,6 +478,9 @@ Nothing else to report in this section
 
 .> UNUSED METHODS:
 =================
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused
 
@@ -531,6 +541,10 @@ Nothing else to report in this section
 
 .>->  ALMOST UNUSED METHODS: Called 1 time(s):
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#peek
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#pop
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#push
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#externally_used
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#internally_used
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#externally_used
@@ -597,6 +611,10 @@ Nothing else to report in this section
 
 .>->  ALMOST UNUSED METHODS: Called 2 time(s):
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:2: counter#get
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:2: counter#incr
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:2: counter#reset
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#used
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#used
 

check/threshold-3-0.5/threshold-3-0.5.ref

@@ -16,6 +16,8 @@
 
 ./examples/docs/exported_values/code_constructs/module/module_lib.mli:6: M.unused
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused
 
@@ -135,6 +137,9 @@
 ./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:2: hello
 ./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:3: goodbye
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:6: push_n_times
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:12: clear_stack
+
 ./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed.mli:1: mark_used
 ./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed_lib.mli:1: mark_used
 ./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed_no_intf.mli:1: mark_used
@@ -349,6 +354,8 @@
 ./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:4: world
 ./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:4: world
 
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:2: used
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:31: exported_f
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:38: internally_used_f
@@ -475,6 +482,9 @@ Nothing else to report in this section
 
 .> UNUSED METHODS:
 =================
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused
 
@@ -535,6 +545,10 @@ Nothing else to report in this section
 
 .>->  ALMOST UNUSED METHODS: Called 1 time(s):
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#peek
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#pop
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#push
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#externally_used
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#internally_used
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#externally_used
@@ -601,6 +615,10 @@ Nothing else to report in this section
 
 .>->  ALMOST UNUSED METHODS: Called 2 time(s):
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:2: counter#get
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:2: counter#incr
+./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:2: counter#reset
+
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#used
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#used
 
@@ -1346,7 +1364,7 @@ Nothing else to report in this section
 --------------------------------------------------------------------------------
 
 
-Total: 1138
-Success: 1134
+Total: 1150
+Success: 1146
 Failed: 4
-Ratio: 99.6485061511%
+Ratio: 99.652173913%

docs/methods/METHODS.md

@@ -130,3 +130,15 @@ from the `.mli` if there is one and the `.ml`.
 > of new unused methods, or remove some for values of object types.
 > Consequently, it is expected that a user might need to compile and analyze
 > their code multiple times when cleaning up their codebase.
+
+# Examples
+
+- The [code constructs](./code_constructs) directory contains a collection of
+  examples dedicated to specific code constructs :
+    - [Immediate object](./code_constructs/IMMEDIATE_OBJ.md)
+
+[TODO]: # (
+    - [Class](./code_constructs/CLASS.md)
+    - [Class type](./code_constructs/CLASS_TYPE.md)
+    - [Inheritance](./code_constructs/INHERITANCE.md)
+    )