[runtime] Add some documentation for the offsets stuff.

[mono.git] / mono / metadata / metadata-cross-helpers.c

diff --git a/mono/metadata/metadata-cross-helpers.c b/mono/metadata/metadata-cross-helpers.c
index 561e9968838f4a69d24e7c6eb77e273118386a88..8253059523687b8120643f7e375d60974707bf23 100644 (file)
--- a/mono/metadata/metadata-cross-helpers.c
+++ b/mono/metadata/metadata-cross-helpers.c
@@ -97,6 +97,12 @@ mono_dump_metadata_offsets (void)
 void
 mono_metadata_cross_helpers_run (void);
 
+/*
+ * mono_metadata_cross_helpers_run:
+ *
+ *   Check that the offsets given by object-offsets.h match the offsets
+ * on the host. This only checks the metadata offsets.
+ */
 void
 mono_metadata_cross_helpers_run (void)
 {