From: <fd...@us...> - 2009-12-06 19:15:57
|
Revision: 5690 http://jnode.svn.sourceforge.net/jnode/?rev=5690&view=rev Author: fduminy Date: 2009-12-06 19:15:41 +0000 (Sun, 06 Dec 2009) Log Message: ----------- added javadoc + links to MagicClass and MagicMethod classes, where "magic" methods are referenced Modified Paths: -------------- trunk/core/src/core/org/jnode/vm/VmMagic.java trunk/core/src/vmmagic/org/vmmagic/unboxed/Address.java trunk/core/src/vmmagic/org/vmmagic/unboxed/Extent.java trunk/core/src/vmmagic/org/vmmagic/unboxed/Offset.java trunk/core/src/vmmagic/org/vmmagic/unboxed/Word.java Modified: trunk/core/src/core/org/jnode/vm/VmMagic.java =================================================================== --- trunk/core/src/core/org/jnode/vm/VmMagic.java 2009-12-03 21:18:57 UTC (rev 5689) +++ trunk/core/src/core/org/jnode/vm/VmMagic.java 2009-12-06 19:15:41 UTC (rev 5690) @@ -33,9 +33,11 @@ * instead of being executed as normal java methods. The actual method * bodies are not used. * <p/> - * Methods is this class can also be called from inside JNode. + * Methods in this class can also be called from inside JNode. * * @author Ewout Prangsma (ep...@us...) + * @see {@link org.jnode.vm.compiler.BaseMagicHelper.MagicClass} to get the list of "magic" classes (including this class). + * @see {@link org.jnode.vm.compiler.BaseMagicHelper.MagicMethod} to get the list of "magic" methods. */ @MagicPermission public final class VmMagic { Modified: trunk/core/src/vmmagic/org/vmmagic/unboxed/Address.java =================================================================== --- trunk/core/src/vmmagic/org/vmmagic/unboxed/Address.java 2009-12-03 21:18:57 UTC (rev 5689) +++ trunk/core/src/vmmagic/org/vmmagic/unboxed/Address.java 2009-12-06 19:15:41 UTC (rev 5690) @@ -18,7 +18,15 @@ import org.jnode.annotation.Uninterruptible; /** - * Stub implementation of an Address type. Needs commenting. + * Stub implementation of an Address type. + * <p/> + * <u>JNode specific notes</u> : This class contains some "magic" + * methods that are interpreted by the VM itself, instead of being executed + * as normal java methods. The actual method bodies are not used. <br/> + * For further details, see the + * {@link org.jnode.vm.compiler.BaseMagicHelper.MagicClass list of "magic" classes} + * and the + * {@link org.jnode.vm.compiler.BaseMagicHelper.MagicMethod list of "magic" methods}. * * @author Daniel Frampton */ Modified: trunk/core/src/vmmagic/org/vmmagic/unboxed/Extent.java =================================================================== --- trunk/core/src/vmmagic/org/vmmagic/unboxed/Extent.java 2009-12-03 21:18:57 UTC (rev 5689) +++ trunk/core/src/vmmagic/org/vmmagic/unboxed/Extent.java 2009-12-06 19:15:41 UTC (rev 5690) @@ -14,8 +14,14 @@ package org.vmmagic.unboxed; /** - * Commenting required - * + * <u>JNode specific notes</u> : This class contains some "magic" + * methods that are interpreted by the VM itself, instead of being executed + * as normal java methods. The actual method bodies are not used. <br/> + * For further details, see the + * {@link org.jnode.vm.compiler.BaseMagicHelper.MagicClass list of "magic" classes} + * and the + * {@link org.jnode.vm.compiler.BaseMagicHelper.MagicMethod list of "magic" methods}. + * * @author Daniel Frampton */ public final class Extent implements UnboxedObject { Modified: trunk/core/src/vmmagic/org/vmmagic/unboxed/Offset.java =================================================================== --- trunk/core/src/vmmagic/org/vmmagic/unboxed/Offset.java 2009-12-03 21:18:57 UTC (rev 5689) +++ trunk/core/src/vmmagic/org/vmmagic/unboxed/Offset.java 2009-12-06 19:15:41 UTC (rev 5690) @@ -14,8 +14,15 @@ package org.vmmagic.unboxed; /** - * To be commented - * + * <p/> + * <u>JNode specific notes</u> : This class contains some "magic" + * methods that are interpreted by the VM itself, instead of being executed + * as normal java methods. The actual method bodies are not used. <br/> + * For further details, see the + * {@link org.jnode.vm.compiler.BaseMagicHelper.MagicClass list of "magic" classes} + * and the + * {@link org.jnode.vm.compiler.BaseMagicHelper.MagicMethod list of "magic" methods}. + * * @author Ewout Prangsma (ep...@us...) * @author Daniel Frampton */ Modified: trunk/core/src/vmmagic/org/vmmagic/unboxed/Word.java =================================================================== --- trunk/core/src/vmmagic/org/vmmagic/unboxed/Word.java 2009-12-03 21:18:57 UTC (rev 5689) +++ trunk/core/src/vmmagic/org/vmmagic/unboxed/Word.java 2009-12-06 19:15:41 UTC (rev 5690) @@ -17,7 +17,14 @@ import org.jnode.annotation.Uninterruptible; /** - * To be commented. + * <p/> + * <u>JNode specific notes</u> : This class contains some "magic" + * methods that are interpreted by the VM itself, instead of being executed + * as normal java methods. The actual method bodies are not used. <br/> + * For further details, see the + * {@link org.jnode.vm.compiler.BaseMagicHelper.MagicClass list of "magic" classes} + * and the + * {@link org.jnode.vm.compiler.BaseMagicHelper.MagicMethod list of "magic" methods}. * * @author Ewout Prangsma (ep...@us...) * @author Daniel Frampton This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |