XNA 4.0 API Specification — Conversion Plan

Overview

Convert the downloaded XNA 4.0 HTML documentation (11,473 HTML files) into a structured, machine-readable spec/ directory. Each XNA type (class, struct, enum, interface, delegate) gets its own XML file. The result replaces the HTML documentation and enables systematic audit of a C++ XNA 4.0 reimplementation.

Source Statistics

Total HTML files: 11,473
Unique API types: 551
- class: 342
- struct: 92
- enum: 101
- interface: 15
- delegate: 1
Namespaces: 19

Directory Structure

spec/
├── xna.xsd              # T-001: master XSD schema
├── index.xml            # T-002: master type index
├── Microsoft.Xna.Framework/
│   ├── Game.xml
│   ├── Vector3.xml
│   └── ...
├── Microsoft.Xna.Framework.Graphics/
│   ├── SpriteBatch.xml
│   └── ...
└── ...

XML Content Per File

Each XML file (TypeName.xml) contains the full documentation for one type:

Summary description
C# syntax declaration (base class, interfaces)
Full Remarks text (verbatim from HTML)
All constructors with parameters and descriptions
All properties (type, access, description, remarks)
All methods with all overloads (parameters, return type, description)
All fields
All events
Enum members with descriptions (for enum types)
Platform availability (Xbox 360, Windows 7/Vista/XP, Windows Phone)

XSD Schema (T-001)

spec/xna.xsd defines root elements <xna-type> and <xna-index> with complex types: ClassType, StructType, EnumType, InterfaceType, DelegateType, PropertyDef, MethodDef, OverloadDef, ParameterDef, ConstructorDef, FieldDef, EventDef, EnumMemberDef, PlatformsDef, SyntaxDef.

Complete Task List

Total tasks: T-001 through T-553 (551 type XMLs + 1 XSD + 1 index = 553 files)

Execution Order

T-001 — Create xna.xsd (schema must exist before any XML can validate)
T-002 — Create index.xml (master type index)
T-003 through T-049 — Microsoft.Xna.Framework (core runtime, highest C++ audit priority)
T-050 through T-??? — Microsoft.Xna.Framework.Graphics (largest namespace)
Continue in namespace priority order as listed in the table above

Implementation Notes

Deduplication: HTML files appear twice (v40 and v41). Use v41 only.
CDATA: Wrap all <summary>, <remarks>, <syntax> content in CDATA.
Overloads: Merge all overloads of a method under one <method> element.
Inherited members: Do NOT duplicate inherited members; use baseClass attribute.
Validation: Every XML must validate against xna.xsd before completion.

Task	File	Kind	Namespace
T-001	`xna.xsd`	XSD schema	—
T-002	`index.xml`	XML index	all namespaces
			Microsoft.Xna.Framework
T-003	`Microsoft.Xna.Framework/BoundingBox.xml`	struct	Microsoft.Xna.Framework
T-004	`Microsoft.Xna.Framework/BoundingFrustum.xml`	class	Microsoft.Xna.Framework
T-005	`Microsoft.Xna.Framework/BoundingSphere.xml`	struct	Microsoft.Xna.Framework
T-006	`Microsoft.Xna.Framework/Color.xml`	struct	Microsoft.Xna.Framework
T-007	`Microsoft.Xna.Framework/ContainmentType.xml`	enum	Microsoft.Xna.Framework
T-008	`Microsoft.Xna.Framework/Curve.xml`	class	Microsoft.Xna.Framework
T-009	`Microsoft.Xna.Framework/CurveContinuity.xml`	enum	Microsoft.Xna.Framework
T-010	`Microsoft.Xna.Framework/CurveKey.xml`	class	Microsoft.Xna.Framework
T-011	`Microsoft.Xna.Framework/CurveKeyCollection.xml`	class	Microsoft.Xna.Framework
T-012	`Microsoft.Xna.Framework/CurveLoopType.xml`	enum	Microsoft.Xna.Framework
T-013	`Microsoft.Xna.Framework/CurveTangent.xml`	enum	Microsoft.Xna.Framework
T-014	`Microsoft.Xna.Framework/DisplayOrientation.xml`	enum	Microsoft.Xna.Framework
T-015	`Microsoft.Xna.Framework/DrawableGameComponent.xml`	class	Microsoft.Xna.Framework
T-016	`Microsoft.Xna.Framework/FrameworkDispatcher.xml`	class	Microsoft.Xna.Framework
T-017	`Microsoft.Xna.Framework/Game.xml`	class	Microsoft.Xna.Framework
T-018	`Microsoft.Xna.Framework/GameComponent.xml`	class	Microsoft.Xna.Framework
T-019	`Microsoft.Xna.Framework/GameComponentCollection.xml`	class	Microsoft.Xna.Framework
T-020	`Microsoft.Xna.Framework/GameComponentCollectionEventArgs.xml`	class	Microsoft.Xna.Framework
T-021	`Microsoft.Xna.Framework/GameServiceContainer.xml`	class	Microsoft.Xna.Framework
T-022	`Microsoft.Xna.Framework/GameTime.xml`	class	Microsoft.Xna.Framework
T-023	`Microsoft.Xna.Framework/GameTimer.xml`	class	Microsoft.Xna.Framework
T-024	`Microsoft.Xna.Framework/GameTimerEventArgs.xml`	class	Microsoft.Xna.Framework
T-025	`Microsoft.Xna.Framework/GameWindow.xml`	class	Microsoft.Xna.Framework
T-026	`Microsoft.Xna.Framework/GraphicsDeviceInformation.xml`	class	Microsoft.Xna.Framework
T-027	`Microsoft.Xna.Framework/GraphicsDeviceManager.xml`	class	Microsoft.Xna.Framework
T-028	`Microsoft.Xna.Framework/IDrawable.xml`	interface	Microsoft.Xna.Framework
T-029	`Microsoft.Xna.Framework/IGameComponent.xml`	interface	Microsoft.Xna.Framework
T-030	`Microsoft.Xna.Framework/IGraphicsDeviceManager.xml`	interface	Microsoft.Xna.Framework
T-031	`Microsoft.Xna.Framework/IUpdateable.xml`	interface	Microsoft.Xna.Framework
T-032	`Microsoft.Xna.Framework/LaunchParameters.xml`	class	Microsoft.Xna.Framework
T-033	`Microsoft.Xna.Framework/MathHelper.xml`	class	Microsoft.Xna.Framework
T-034	`Microsoft.Xna.Framework/Matrix.xml`	struct	Microsoft.Xna.Framework
T-035	`Microsoft.Xna.Framework/NoSuitableGraphicsDeviceException.xml`	class	Microsoft.Xna.Framework
T-036	`Microsoft.Xna.Framework/Plane.xml`	struct	Microsoft.Xna.Framework
T-037	`Microsoft.Xna.Framework/PlaneIntersectionType.xml`	enum	Microsoft.Xna.Framework
T-038	`Microsoft.Xna.Framework/PlayerIndex.xml`	enum	Microsoft.Xna.Framework
T-039	`Microsoft.Xna.Framework/Point.xml`	struct	Microsoft.Xna.Framework

FilesExpand file tree

plan.md

Latest commit

History