From 7e2f6f2a927a249327be28442b2c7b78b74850a9 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sun, 22 Jun 2025 16:52:45 +0300 Subject: Update and organize documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Renamed all uppercase markdown files to lowercase for consistency - ARCHITECTURE.md -> architecture.md - DEVELOPER_GUIDE.md -> developer-guide.md - TIMESTAMP_EVENTS_GUIDE.md -> timestamp-events-guide.md - SERIALIZATION_NOTES.txt -> serialization-notes.txt - Removed all Raft references from documentation - Updated build-fixes-summary.md - Updated testing-guide.md - Updated test-infrastructure.md - Updated simulation-builder-framework.md - Created index.md for easy documentation navigation - Organized docs by category (Architecture, Testing, GUI Decoupling, etc.) - Added quick links for different user types - Included documentation standards and contribution guidelines All documentation is now consistent and up-to-date with the current codebase. 🤖 Generated with Claude Code https://claude.ai/code Co-Authored-By: Claude --- docs/serialization-notes.txt | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/serialization-notes.txt (limited to 'docs/serialization-notes.txt') diff --git a/docs/serialization-notes.txt b/docs/serialization-notes.txt new file mode 100644 index 0000000..44ad0a4 --- /dev/null +++ b/docs/serialization-notes.txt @@ -0,0 +1,40 @@ +VSSerialize + prefs(=VSPrefs).serialize + writeObject(...) + simulator(=VSSimulator).serialize + simulatorCanvas(=VSSimulatorCanvas).serialize + writeObject(numProcesses) + for (porcess : processes) process(=VSProcess).serialize { + super(=VSPrefs).serialize + writeObject(processID) + writeObject(numProtocolsToReset) + for (protocol : protocolsToReset) { + writeObject(protocolClassname) + protocol(=VSAbstractProtocol).serialize + super(=VSAbstractEvent).serialize + super(=VSPrefs).serialize + s.o. + writeObject(id) + writeObject(eventShortname) + writeObject(eventClassname) + writeObject(hasOnServerStart) + } + } + taskManager(=VSTaskManager).serialize + writeObject(numTasks) + for (task : tasks) task(=VSTask).serialize + writeObject(eventClassname) + event(=VSAbstractEvent).serialize + s.o. + writeObject(eventID) + writeObject(processNum) + writeObject(taskNum) + writeObject(taskTime) + writeObject(isGlobalTimed) + writeObject(isProgrammed) + +VSProtocolEvent.serialize + super(=VSAbstractEvent).serialize + writeObject(protocolClassname) + writeObject(isClientProtocol) + writeObject(isProtocolActivation) -- cgit v1.2.3