Changeset 9179d0a in mainline for generic/src/mm/page.c

Timestamp:

2006-04-27T17:13:49Z (19 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

040e4e9

Parents:

eaa202a

Message:

Add some @file doxygen comments and improve already existing comments.

File:

• generic/src/mm/page.c (modified) (3 diffs)

generic/src/mm/page.c

@@ -27 +27 @@
  */
 
-/*
- * Virtual Address Translation subsystem.
+/**
+ * @file        page.c
+ * @brief       Virtual Address Translation subsystem.
+ *
+ * This file contains code for creating, destroying and searching
+ * mappings between virtual addresses and physical addresses.
+ * Functions here are mere wrappers that call the real implementation.
+ * They however, define the single interface. 
  */
 
@@ -74 +80 @@
 /** Insert mapping of page to frame.
  *
- * Map virtual address @page to physical address @frame
- * using @flags. Allocate and setup any missing page tables.
+ * Map virtual address page to physical address frame
+ * using flags. Allocate and setup any missing page tables.
  *
  * The page table must be locked and interrupts must be disabled.
@@ -94 +100 @@
 /** Remove mapping of page.
  *
- * Remove any mapping of @page within address space @as.
+ * Remove any mapping of page within address space as.
  * TLB shootdown should follow in order to make effects of
  * this call visible.