Skip to content

Commit 7c0f580

Browse files
fantaziofantazio
committed
[docs][methods][3/n] add class example
This demonstrates the use by explict references and use by requirements.
1 parent 9078290 commit 7c0f580

File tree

15 files changed

+457
-13
lines changed

15 files changed

+457
-13
lines changed

‎check/classic/classic.exp‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,9 @@ Nothing else to report in this section
148148

149149
.> UNUSED METHODS:
150150
=================
151+
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
152+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#reset
153+
151154
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
152155
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
153156

‎check/classic/classic.ref‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,9 @@ Nothing else to report in this section
149149

150150
.> UNUSED METHODS:
151151
=================
152+
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
153+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#reset
154+
152155
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
153156
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
154157

@@ -622,7 +625,7 @@ Nothing else to report in this section
622625
--------------------------------------------------------------------------------
623626

624627

625-
Total: 534
626-
Success: 533
628+
Total: 536
629+
Success: 535
627630
Failed: 1
628-
Ratio: 99.8127340824%
631+
Ratio: 99.8134328358%

‎check/internal/internal.exp‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,9 @@ Nothing else to report in this section
103103

104104
.> UNUSED METHODS:
105105
=================
106+
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
107+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#reset
108+
106109
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
107110
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
108111

‎check/internal/internal.ref‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,9 @@ Nothing else to report in this section
104104

105105
.> UNUSED METHODS:
106106
=================
107+
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
108+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#reset
109+
107110
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
108111
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
109112

@@ -577,7 +580,7 @@ Nothing else to report in this section
577580
--------------------------------------------------------------------------------
578581

579582

580-
Total: 492
581-
Success: 491
583+
Total: 494
584+
Success: 493
582585
Failed: 1
583-
Ratio: 99.7967479675%
586+
Ratio: 99.7975708502%

‎check/threshold-1/threshold-1.exp‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,9 @@
133133
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:2: hello
134134
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:3: goodbye
135135

136+
./examples/docs/methods/code_constructs/class/class_bin.ml:6: push_n_times
137+
./examples/docs/methods/code_constructs/class/class_bin.ml:12: clear_stack
138+
136139
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:6: push_n_times
137140
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:12: clear_stack
138141

@@ -341,6 +344,9 @@ Nothing else to report in this section
341344

342345
.> UNUSED METHODS:
343346
=================
347+
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
348+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#reset
349+
344350
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
345351
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
346352

@@ -404,6 +410,10 @@ Nothing else to report in this section
404410

405411
.>-> ALMOST UNUSED METHODS: Called 1 time(s):
406412
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
413+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#peek
414+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#pop
415+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#push
416+
407417
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#peek
408418
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#pop
409419
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#push

‎check/threshold-1/threshold-1.ref‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,9 @@
137137
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:2: hello
138138
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:3: goodbye
139139

140+
./examples/docs/methods/code_constructs/class/class_bin.ml:6: push_n_times
141+
./examples/docs/methods/code_constructs/class/class_bin.ml:12: clear_stack
142+
140143
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:6: push_n_times
141144
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:12: clear_stack
142145

@@ -345,6 +348,9 @@ Nothing else to report in this section
345348

346349
.> UNUSED METHODS:
347350
=================
351+
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
352+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#reset
353+
348354
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
349355
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
350356

@@ -408,6 +414,10 @@ Nothing else to report in this section
408414

409415
.>-> ALMOST UNUSED METHODS: Called 1 time(s):
410416
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
417+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#peek
418+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#pop
419+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#push
420+
411421
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#peek
412422
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#pop
413423
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#push
@@ -962,7 +972,7 @@ Nothing else to report in this section
962972
--------------------------------------------------------------------------------
963973

964974

965-
Total: 829
966-
Success: 825
975+
Total: 836
976+
Success: 832
967977
Failed: 4
968-
Ratio: 99.517490953%
978+
Ratio: 99.5215311005%

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,9 @@
133133
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:2: hello
134134
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:3: goodbye
135135

136+
./examples/docs/methods/code_constructs/class/class_bin.ml:6: push_n_times
137+
./examples/docs/methods/code_constructs/class/class_bin.ml:12: clear_stack
138+
136139
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:6: push_n_times
137140
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:12: clear_stack
138141

@@ -350,6 +353,8 @@
350353
./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:4: world
351354
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:4: world
352355

356+
./examples/docs/methods/code_constructs/class/class_lib.mli:17: int_stack
357+
353358
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack
354359

355360
./examples/using_dune/preprocessed_lib/preprocessed.mli:2: used
@@ -478,6 +483,9 @@ Nothing else to report in this section
478483

479484
.> UNUSED METHODS:
480485
=================
486+
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
487+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#reset
488+
481489
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
482490
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
483491

@@ -541,6 +549,10 @@ Nothing else to report in this section
541549

542550
.>-> ALMOST UNUSED METHODS: Called 1 time(s):
543551
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
552+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#peek
553+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#pop
554+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#push
555+
544556
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#peek
545557
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#pop
546558
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#push
@@ -611,6 +623,10 @@ Nothing else to report in this section
611623

612624
.>-> ALMOST UNUSED METHODS: Called 2 time(s):
613625
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
626+
./examples/docs/methods/code_constructs/class/class_lib.mli:2: counter#get
627+
./examples/docs/methods/code_constructs/class/class_lib.mli:2: counter#incr
628+
./examples/docs/methods/code_constructs/class/class_lib.mli:2: counter#reset
629+
614630
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:2: counter#get
615631
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:2: counter#incr
616632
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:2: counter#reset

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

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,9 @@
137137
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:2: hello
138138
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:3: goodbye
139139

140+
./examples/docs/methods/code_constructs/class/class_bin.ml:6: push_n_times
141+
./examples/docs/methods/code_constructs/class/class_bin.ml:12: clear_stack
142+
140143
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:6: push_n_times
141144
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:12: clear_stack
142145

@@ -354,6 +357,8 @@
354357
./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:4: world
355358
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:4: world
356359

360+
./examples/docs/methods/code_constructs/class/class_lib.mli:17: int_stack
361+
357362
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack
358363

359364
./examples/using_dune/preprocessed_lib/preprocessed.mli:2: used
@@ -482,6 +487,9 @@ Nothing else to report in this section
482487

483488
.> UNUSED METHODS:
484489
=================
490+
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
491+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#reset
492+
485493
./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
486494
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
487495

@@ -545,6 +553,10 @@ Nothing else to report in this section
545553

546554
.>-> ALMOST UNUSED METHODS: Called 1 time(s):
547555
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
556+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#peek
557+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#pop
558+
./examples/docs/methods/code_constructs/class/class_lib.mli:8: int_stack#push
559+
548560
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#peek
549561
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#pop
550562
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#push
@@ -615,6 +627,10 @@ Nothing else to report in this section
615627

616628
.>-> ALMOST UNUSED METHODS: Called 2 time(s):
617629
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
630+
./examples/docs/methods/code_constructs/class/class_lib.mli:2: counter#get
631+
./examples/docs/methods/code_constructs/class/class_lib.mli:2: counter#incr
632+
./examples/docs/methods/code_constructs/class/class_lib.mli:2: counter#reset
633+
618634
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:2: counter#get
619635
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:2: counter#incr
620636
./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:2: counter#reset
@@ -1364,7 +1380,7 @@ Nothing else to report in this section
13641380
--------------------------------------------------------------------------------
13651381

13661382

1367-
Total: 1150
1368-
Success: 1146
1383+
Total: 1161
1384+
Success: 1157
13691385
Failed: 4
1370-
Ratio: 99.652173913%
1386+
Ratio: 99.6554694229%

‎docs/methods/METHODS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,9 @@ from the `.mli` if there is one and the `.ml`.
136136
- The [code constructs](./code_constructs) directory contains a collection of
137137
examples dedicated to specific code constructs :
138138
- [Immediate object](./code_constructs/IMMEDIATE_OBJ.md)
139+
- [Class](./code_constructs/CLASS.md)
139140

140141
[TODO]: # (
141-
- [Class](./code_constructs/CLASS.md)
142142
- [Class type](./code_constructs/CLASS_TYPE.md)
143143
- [Inheritance](./code_constructs/INHERITANCE.md)
144144
)

0 commit comments

Comments
 (0)