[docs] Enable documentation for sgen.
authorJon Purdy <evincarofautumn@gmail.com>
Fri, 10 Feb 2017 23:32:44 +0000 (15:32 -0800)
committerJon Purdy <evincarofautumn@gmail.com>
Fri, 24 Mar 2017 20:43:07 +0000 (13:43 -0700)
51 files changed:
mono/sgen/gc-internal-agnostic.h
mono/sgen/sgen-alloc.c
mono/sgen/sgen-archdep.h
mono/sgen/sgen-array-list.c
mono/sgen/sgen-array-list.h
mono/sgen/sgen-cardtable.c
mono/sgen/sgen-cardtable.h
mono/sgen/sgen-client.h
mono/sgen/sgen-conf.h
mono/sgen/sgen-copy-object.h
mono/sgen/sgen-debug.c
mono/sgen/sgen-descriptor.c
mono/sgen/sgen-descriptor.h
mono/sgen/sgen-fin-weak-hash.c
mono/sgen/sgen-gc.c
mono/sgen/sgen-gc.h
mono/sgen/sgen-gchandles.c
mono/sgen/sgen-gray.c
mono/sgen/sgen-gray.h
mono/sgen/sgen-hash-table.c
mono/sgen/sgen-hash-table.h
mono/sgen/sgen-internal.c
mono/sgen/sgen-layout-stats.c
mono/sgen/sgen-layout-stats.h
mono/sgen/sgen-los.c
mono/sgen/sgen-major-copy-object.h
mono/sgen/sgen-marksweep-drain-gray-stack.h
mono/sgen/sgen-marksweep.c
mono/sgen/sgen-memory-governor.c
mono/sgen/sgen-memory-governor.h
mono/sgen/sgen-minor-copy-object.h
mono/sgen/sgen-minor-scan-object.h
mono/sgen/sgen-nursery-allocator.c
mono/sgen/sgen-pinning-stats.c
mono/sgen/sgen-pinning.c
mono/sgen/sgen-pinning.h
mono/sgen/sgen-pointer-queue.c
mono/sgen/sgen-pointer-queue.h
mono/sgen/sgen-protocol-def.h
mono/sgen/sgen-protocol.c
mono/sgen/sgen-protocol.h
mono/sgen/sgen-qsort.c
mono/sgen/sgen-qsort.h
mono/sgen/sgen-scan-object.h
mono/sgen/sgen-simple-nursery.c
mono/sgen/sgen-split-nursery.c
mono/sgen/sgen-tagged-pointer.h
mono/sgen/sgen-thread-pool.c
mono/sgen/sgen-thread-pool.h
mono/sgen/sgen-workers.c
mono/sgen/sgen-workers.h

index dc9b091bf6f95262b3dd0bec4a1903c88576e3d7..54953e85d4cea98c4f03ee78afbaa902146ccc58 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * gc-internal-agnostic.h: Mono-agnostic GC interface.
+/**
+ * \file
+ * Mono-agnostic GC interface.
  *
  * Copyright (C) 2015 Xamarin Inc
  *
index 3b167f893814ea2375bd9236b743ed7e4a3a19d2..20ecc4e5f2f3e4ab146bd772f8bfabe80cde69b2 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-alloc.c: Object allocation routines + managed allocators
+/**
+ * \file
+ * Object allocation routines + managed allocators
  *
  * Author:
  *     Paolo Molaro (lupus@ximian.com)
index d0314e8ccfd99166524ccec93893e2cdc12d9764..274f6dac2fdabdfed67add95ea4a76eaa559f494 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-archdep.h: Architecture dependent parts of SGen.
+/**
+ * \file
+ * Architecture dependent parts of SGen.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index 4150e4b824e6aad234bb88b1a74a84a33cdd4a13..0247a6b12695c3e1368d327fefd5f58dd31fd2da 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-array-list.c: A pointer array list that doesn't require reallocs
+/**
+ * \file
+ * A pointer array list that doesn't require reallocs
  *
  * Copyright (C) 2016 Xamarin Inc
  *
index c505833ae01c727e5b3a8e2dce5b77d1db71148b..12e8bcdecf70f419c23c0cc65bcad7faac32e396 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-array-list.h: A pointer array that doesn't use reallocs.
+/**
+ * \file
+ * A pointer array that doesn't use reallocs.
  *
  * Copyright (C) 2016 Xamarin Inc
  *
index 0138669a78897f120a97561e8f96b22edb5cfa57..42a9101b1d66eb591e57be26164b5454e1dbe46f 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-cardtable.c: Card table implementation for sgen
+/**
+ * \file
+ * Card table implementation for sgen
  *
  * Author:
  *     Rodrigo Kumpera (rkumpera@novell.com)
index a4fa1e32b6e91b2be1b3f281c21172bdbed6744c..ad2e23a3adbbba4444d62a46be59c57bfdd8c638 100644 (file)
@@ -1,4 +1,5 @@
-/*
+/**
+ * \file
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
  *
index b1f46068cb3594e91a11309ae72797ada4bc0bc1..11e6451d5b66b34418fb6fdd2ef66025be26d00f 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-client.h: SGen client interface.
+/**
+ * \file
+ * SGen client interface.
  *
  * Copyright (C) 2014 Xamarin Inc
  *
index 429dcb26af30a8b2370225bf988dc247aa7db7b5..d9296ca15945b9a4dcfeb066d9751de9c17d9704 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-conf.h: Tunable parameters and debugging switches.
+/**
+ * \file
+ * Tunable parameters and debugging switches.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index 4c3eae0f09e3db3c7736872a54640a0565f722f0..1e3d3918b65ce7187ff5a09ff6a9f7e4223cdfe3 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-copy-object.h: This is where objects are copied.
+/**
+ * \file
+ * This is where objects are copied.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index ae8e2ab2f20cb5498bb559cb577e9c18c37c01cf..b519a1ec58eb17750a9407ea4269317c22f57e95 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-debug.c: Collector debugging
+/**
+ * \file
+ * Collector debugging
  *
  * Author:
  *     Paolo Molaro (lupus@ximian.com)
index f358c9da42977d736172a2d3fe15b8798ecf6970..42575b795077d6c8a8f761a8196253ef265dfdf9 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-descriptor.c: GC descriptors describe object layout.
+/**
+ * \file
+ * GC descriptors describe object layout.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index e072ca45d3267c1e21108f9eaafd7d33c0a62767..2c7f19b18c46a4d1029174e5bb509f1916af57b0 100644 (file)
@@ -1,6 +1,7 @@
-/*
- * sgen-descriptor.h: GC descriptors describe object layout.
-
+/**
+ * \file
+ * GC descriptors describe object layout.
+ *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
index bef8bcded6fdb1ea3440012debe30e9a21ac7996..e227281c12d96e0d45b2d49fd6f557e9d24afaee 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-fin-weak-hash.c: Finalizers and weak links.
+/**
+ * \file
+ * Finalizers and weak links.
  *
  * Author:
  *     Paolo Molaro (lupus@ximian.com)
index ec27de4224b9520a93998439738af18de6bbf08d..2475a106ff966243e208ce6bdbf0a6620df1fe19 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-gc.c: Simple generational GC.
+/**
+ * \file
+ * Simple generational GC.
  *
  * Author:
  *     Paolo Molaro (lupus@ximian.com)
index a89a5471dd729c563d09721fcd4a5bd9ccdadf68..e8df83337a63fc88e57f4a40aa34a0ea8c68f39b 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-gc.c: Simple generational GC.
+/**
+ * \file
+ * Simple generational GC.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index 6fc24a2151a8e4b464f94cb5724afe32af392a6e..f38fe27721ccd9fdeb0fa0c962a67d15f8d4745c 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-gchandles.c: SGen GC handles.
+/**
+ * \file
+ * SGen GC handles.
  *
  * Copyright (C) 2015 Xamarin Inc
  *
index 256b18ecbe6e86965c1aef14bbfb5796442d3399..ccd65867f2b75f870b63a3c85215f9cbe7fa8abd 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-gray.c: Gray queue management.
+/**
+ * \file
+ * Gray queue management.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index b2f69d0586d2dd296a42c0d573fbc4c78a2d677e..bbaefe07575539c21e9ba7f02708f8d5a8b1148a 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-gray.h: Gray queue management.
+/**
+ * \file
+ * Gray queue management.
  *
  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
  * Copyright (C) 2012 Xamarin Inc
index 42856fc65d846a016638bf1ed9b043792540d17e..3ceebc77f30c738e52d2086a73b70da368fcb215 100644 (file)
@@ -1,5 +1,5 @@
-/*
- * sgen-hash-table.c
+/**
+ * \file
  *
  * Permission is hereby granted, free of charge, to any person obtaining
  * a copy of this software and associated documentation files (the
index 5144cab12702b55ce432e22ae37c785bbc429fb6..389fca32a030da39da1e4b6e08f6fa9e32e9180f 100644 (file)
@@ -1,3 +1,7 @@
+/**
+ * \file
+ */
+
 #ifndef __MONO_SGENHASHTABLE_H__
 #define __MONO_SGENHASHTABLE_H__
 
index e8c0d7ab595a74fa63e86d3a8e03e087df4fd542..49ab78651c258250a0c096164bbadf386ededd54 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-internal.c: Internal lock-free memory allocator.
+/**
+ * \file
+ * Internal lock-free memory allocator.
  *
  * Copyright (C) 2012 Xamarin Inc
  *
index 04b1f241e1abaff2b96990b572e1bdf5e5bf8907..103ef31436465d683b500229926c512e575adc03 100644 (file)
@@ -1,4 +1,5 @@
-/*
+/**
+ * \file
  * Copyright Xamarin Inc (http://www.xamarin.com)
  *
  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
index 024e0192442b01e66e451189399ddf06bd99a18a..ed25ba5b81db36651b39c9b6cc6c80e39307930a 100644 (file)
@@ -1,4 +1,5 @@
-/*
+/**
+ * \file
  * Copyright Xamarin Inc (http://www.xamarin.com)
  *
  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
index e61ba557818f7ac6516d3c5ccff295d113cde566..791eaa25abc15fc3868559945a0da42c43f5f7c4 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-los.c: Large objects space.
+/**
+ * \file
+ * Large objects space.
  *
  * Author:
  *     Paolo Molaro (lupus@ximian.com)
index 826aca9dfd1fa7b5fb32ebe9d8f9f0a6175a036a..e04bf9e063cf1727207af8ae62bbb5892d563936 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-major-copy-object.h: Object copying in the major collectors.
+/**
+ * \file
+ * Object copying in the major collectors.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index 98d8917593cd385d6f77c5bdfed4facb5e96ef63..4a76eb460311eb3b89af301bc2031a40a31a7665 100644 (file)
@@ -1,6 +1,6 @@
-/*
- * sgen-marksweep-drain-gray-stack.h: The copy/mark and gray stack
- *     draining functions of the M&S major collector.
+/**
+ * \file
+ * The copy/mark and gray stack draining functions of the M&S major collector.
  *
  * Copyright (C) 2014 Xamarin Inc
  *
index 5c4ec06a9ebda9b21afd80477086a42fe303ba00..67b422c1990c10c52989478c2331e14b0f1dfbb3 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-marksweep.c: The Mark & Sweep major collector.
+/**
+ * \file
+ * The Mark & Sweep major collector.
  *
  * Author:
  *     Mark Probst <mark.probst@gmail.com>
index d6c7f130f3cae7571d5524cd7cdf67c65119ce28..8dae5a062fd6ddcc54ee582cd161624449ee6a11 100644 (file)
@@ -1,6 +1,6 @@
-/*
- * sgen-memory-governor.c: When to schedule collections based on
- * memory usage.
+/**
+ * \file
+ * When to schedule collections based on memory usage.
  *
  * Author:
  *     Rodrigo Kumpera (rkumpera@novell.com)
index 585fbe9a8388af909098645da5304d8a7ff2e121..81c02dab5bec904551c0c9aa6ba8954985ae4b85 100644 (file)
@@ -1,4 +1,5 @@
-/*
+/**
+ * \file
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
  *
index da392c4292847badfe7fcc5a9b01e9c2cb082851..9ba0d129522e677b98bf87768d72b09c1e2fc2c4 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-minor-copy-object.h: Copy functions for nursery collections.
+/**
+ * \file
+ * Copy functions for nursery collections.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index 2c357c3c9524c7d3e06b90cfb0aa354918f6e669..aadfe068e24f401bf99510dcebda4595031c6b91 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-minor-scan-object.h: Object scanning in the nursery collectors.
+/**
+ * \file
+ * Object scanning in the nursery collectors.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index 77a3aa866f743573c2c04da3c52352506d970e0a..91611877ce6423b43acd2a6c690ac36c884bc5db 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-nursery-allocator.c: Nursery allocation code.
+/**
+ * \file
+ * Nursery allocation code.
  *
  * Copyright 2009-2010 Novell, Inc.
  *           2011 Rodrigo Kumpera
index ab00a56d66dd26cca6eb188000031cde4e95d3f0..f98158077b88e507cefb1e47ed8a96cd4a464af3 100644 (file)
@@ -1,4 +1,5 @@
-/*
+/**
+ * \file
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
index be803daffa7a53f3d09596b1a0b51c4261620033..904688c2ae81f628eb8b52d37da7ddfc03564927 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-pinning.c: The pin queue.
+/**
+ * \file
+ * The pin queue.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index 2ae2594fa85e1c762898e60d43e6caafaf0ed40a..cdd673f29b5b2ca2df1613f1911bc9cd456bfb1b 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-pinning.h: All about pinning objects.
+/**
+ * \file
+ * All about pinning objects.
  *
  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
  * Copyright (C) 2012 Xamarin Inc
index 5fb25b0bdc53ce85ac6244422f841c6ff645e813..ed7d92f6f2ab0150db83d3619259937969a2a0a5 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-pointer-queue.c: A pointer queue that can be sorted.
+/**
+ * \file
+ * A pointer queue that can be sorted.
  *
  * Copyright (C) 2014 Xamarin Inc
  *
index 5127b5bdc1db15038b16213469545ee12d17c76a..52c9b7ec916fe002a72fbed2ca27d1a393a8bfb6 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-pointer-queue.h: A pointer queue that can be sorted.
+/**
+ * \file
+ * A pointer queue that can be sorted.
  *
  * Copyright (C) 2014 Xamarin Inc
  *
index e6f1f775c917bbfcece04939dda8a6d4d0e3e3a5..08bfdfe890ee2d9ddf8a4e91f1f8158d66363a36 100644 (file)
@@ -1,4 +1,5 @@
-/*
+/**
+ * \file
  * All binary protocol entries are defined here.  To keep compatibility with past binary
  * protocol files, new protocol entries need to be defined at the end of the file so that
  * the sequential numbering is preserved.  We also can't change the types or numbers of
index 66e80d97e55483c544d38ed56214085926010149..419e90a482a50faa961382308edd80844b743a17 100644 (file)
@@ -1,6 +1,6 @@
-/*
- * sgen-protocol.c: Binary protocol of internal activity, to aid
- * debugging.
+/**
+ * \file
+ * Binary protocol of internal activity, to aid debugging.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index f0da36fd73def734e02e7740f24c1207215781f0..8b82dc3794aee3a4eb19c7bf3b06da97f34115db 100644 (file)
@@ -1,6 +1,6 @@
-/*
- * sgen-protocol.h: Binary protocol of internal activity, to aid
- * debugging.
+/**
+ * \file
+ * Binary protocol of internal activity, to aid debugging.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index 5139a2b4e7a2be1645a74a9be4352cbbe3461edd..e8144244a6c198f78502f058701984e7a0c18895 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-qsort.c: Quicksort.
+/**
+ * \file
+ * Quicksort.
  *
  * Copyright (C) 2013 Xamarin Inc
  *
index 46a7489691086013a11f35ce74a8ce8206295aaa..f77d21b724214d2ac0b0dbb2c8ad7da626be7ebe 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-qsort.h: Fast inline sorting
+/**
+ * \file
+ * Fast inline sorting
  *
  * Copyright (C) 2014 Xamarin Inc
  *
index b5cbedaa92ec50bb9d0b1237e353a244ad4a6303..d6da307a734ee4d0cb74039412d0eb0004be9c17 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-scan-object.h: Generic object scan.
+/**
+ * \file
+ * Generic object scan.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index bc8aee7044c8a12baaa684e9411893dedf9f567a..24a59f759a97602d2d1c0d99558201d775940bf9 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-simple-nursery.c: Simple always promote nursery.
+/**
+ * \file
+ * Simple always promote nursery.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index a4deb5a3c6a702d2e65b37c1530102f8767776dc..078e1908d4e36855e3dfe2fd0202371793210911 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-splliy-nursery.c: 3-space based nursery collector.
+/**
+ * \file
+ * 3-space based nursery collector.
  *
  * Author:
  *     Rodrigo Kumpera Kumpera <kumpera@gmail.com>
index 8b28fde01707b1b46fa2d5f292400cefca3154fc..7abb01b022ff0c56849bdf80fb5779f021594bbc 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-tagged-pointer.h: Macros for tagging and untagging pointers.
+/**
+ * \file
+ * Macros for tagging and untagging pointers.
  *
  * Copyright (C) 2014 Xamarin Inc
  *
index 20c5e17d3d7464fc90ac156b0efdaeb3d45b8b6a..6f164d278c1b7d9b9a075c3de72506c0d2ba021a 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-thread-pool.c: Threadpool for all concurrent GC work.
+/**
+ * \file
+ * Threadpool for all concurrent GC work.
  *
  * Copyright (C) 2015 Xamarin Inc
  *
index 329cc148c1c8bb966488c6c2ba6ea370e49ad393..ce4bb11e321ee58668336c2a6989fa7ee71d4e6e 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-thread-pool.h: Threadpool for all concurrent GC work.
+/**
+ * \file
+ * Threadpool for all concurrent GC work.
  *
  * Copyright (C) 2015 Xamarin Inc
  *
index 77c9413ac6c9a540283f3947a9a0a7b177968888..f5169f45ab2e711c87ac1a59d41007ef8715b236 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-workers.c: Worker threads for parallel and concurrent GC.
+/**
+ * \file
+ * Worker threads for parallel and concurrent GC.
  *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
index 4c84ea10219ca2208bb3bd380af152e08540b7c8..e2f030dc159135210d50d80fd1e60a5799e7291a 100644 (file)
@@ -1,5 +1,6 @@
-/*
- * sgen-workers.c: Worker threads for parallel and concurrent GC.
+/**
+ * \file
+ * Worker threads for parallel and concurrent GC.
  *
  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
  * Copyright (C) 2012 Xamarin Inc