MetarParser icon indicating copy to clipboard operation
MetarParser copied to clipboard

Update README documentation with comprehensive model entities and enums

Open Copilot opened this issue 5 months ago • 2 comments

This PR addresses the issue of outdated and incomplete documentation in the README.md model section by providing comprehensive coverage of all current entities and enums in the MetarParser project.

Issues Fixed

Incorrect Documentation:

  • Removed references to non-existent enums DepositBrakingCapacity and DepositThickness which are actually String fields in RunwayInfo, not enums
  • Fixed duplicate DepositType entry in the enumerations list
  • Corrected Wind class documentation to include the missing directionDegrees field and proper field types

Missing Documentation:

  • Added documentation for 4 new weather category enums that implement the WeatherCategory interface
  • Added documentation for the TemperatureDated class
  • Added comprehensive documentation for abstract classes and interfaces

New Model Classes Documented

Weather Categories

  • FAAWeatherCategory: US aviation weather categories (LIFR, IFR, MVFR, VFR) with detailed criteria
  • GAFORWeatherCategory: German aviation weather categories with reference to official DWD documentation
  • ICAOWeatherCategory: International aviation categories (IMC, VMC) based on ICAO standards
  • MilitaryWeatherCategory: Military color-coded categories (RED, AMB, YLO, GRN, WHT, BLU) with specific visibility/ceiling criteria

Additional Classes

  • TemperatureDated: Class for temperature readings with associated date and time information
  • WeatherCategory: Interface defining the contract for weather category implementations

Architecture Documentation

  • AbstractWeatherContainer: Base class providing common weather fields for METAR and TAF objects
  • AbstractWeatherCode: Parent class of METAR and TAF extending AbstractWeatherContainer
  • ITafGroups: Interface for TAF-specific elements like turbulence and icing

Enhancements

  • Added detailed descriptions and example values for key enums like Intensity, Phenomenon, and WeatherChangeType
  • Improved organization with separate sections for abstract classes vs concrete classes
  • Added reference links to official aviation standards for weather categories
  • Clarified which fields are optional and specified correct data types throughout

The documentation now accurately reflects the current codebase structure and provides developers with complete information about all available model entities, enums, and architectural components.

[!WARNING]

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • checkstyle.org
    • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.11/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.11/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.11 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.11/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/MetarParser/MetarParser org.codehaus.plexus.classworlds.launcher.Launcher clean compile -q (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot avatar Sep 22 '25 21:09 Copilot