Update the @file for doxygen to fix conflicts

brentru · brentru · commit 13af84915164 · 2025-04-18T11:21:17.000-04:00
diff --git a/src/components/analogIO/controller.cpp b/src/components/analogIO/controller.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file controller.cpp
+ * @file src/components/analogIO/controller.cpp
  *
  * Controller for the analogio.proto API
  *
diff --git a/src/components/analogIO/controller.h b/src/components/analogIO/controller.h
@@ -1,5 +1,5 @@
 /*!
- * @file controller.h
+ * @file src/components/analogIO/controller.h
  *
  * Controller for the AnalogIO API
  *
diff --git a/src/components/analogIO/hardware.cpp b/src/components/analogIO/hardware.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file hardware.cpp
+ * @file src/components/analogIO/hardware.cpp
  *
  * Hardware interface for the analogio.proto API
  *
diff --git a/src/components/analogIO/hardware.h b/src/components/analogIO/hardware.h
@@ -1,5 +1,5 @@
 /*!
- * @file model.h
+ * @file src/components/analogIO/hardware.h
  *
  * Hardware implementation for the analogio.proto message.
  *
diff --git a/src/components/analogIO/model.cpp b/src/components/analogIO/model.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file model.cpp
+ * @file src/components/analogIO/model.cpp
  *
  * Interfaces for the analogio.proto API
  *
diff --git a/src/components/analogIO/model.h b/src/components/analogIO/model.h
@@ -1,5 +1,5 @@
 /*!
- * @file model.h
+ * @file src/components/analogIO/model.h
  *
  * Model interface for the analogio.proto message.
  *
diff --git a/src/components/checkin/model.cpp b/src/components/checkin/model.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file model.cpp
+ * @file src/components/checkin/model.cpp
  *
  * Model for the Wippersnapper checkin proto API.
  *
diff --git a/src/components/checkin/model.h b/src/components/checkin/model.h
@@ -1,5 +1,5 @@
 /*!
- * @file model.h
+ * @file src/components/checkin/model.h
  *
  * Model for the Wippersnapper checkin proto API.
  *
diff --git a/src/components/digitalIO/controller.cpp b/src/components/digitalIO/controller.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file controller.cpp
+ * @file src/components/digitalIO/controller.cpp
  *
  * Controller for the digitalio.proto API
  *
diff --git a/src/components/digitalIO/controller.h b/src/components/digitalIO/controller.h
@@ -1,5 +1,5 @@
 /*!
- * @file controller.h
+ * @file src/components/digitalIO/controller.h
  *
  * Controller for the digitalio API
  *
diff --git a/src/components/digitalIO/hardware.cpp b/src/components/digitalIO/hardware.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file hardware.cpp
+ * @file src/components/digitalIO/hardware.cpp
  *
  * Hardware driver for the digitalio.proto API
  *
diff --git a/src/components/digitalIO/hardware.h b/src/components/digitalIO/hardware.h
@@ -1,7 +1,7 @@
 /*!
- * @file model.h
+ * @file src/components/digitalIO/hardware.h
  *
- * Model for the digitalio.proto message.
+ * Hardware for the digitalio.proto message.
  *
  * Adafruit invests time and resources providing this open source code,
  * please support Adafruit and open-source hardware by purchasing
diff --git a/src/components/digitalIO/model.cpp b/src/components/digitalIO/model.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file model.cpp
+ * @file src/components/digitalIO/model.cpp
  *
  * Model for the digitalio.proto message.
  *
diff --git a/src/components/digitalIO/model.h b/src/components/digitalIO/model.h
@@ -1,5 +1,5 @@
 /*!
- * @file model.h
+ * @file src/components/digitalIO/model.h
  *
  * Model for the digitalio.proto message.
  *
diff --git a/src/components/ds18x20/controller.cpp b/src/components/ds18x20/controller.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file controller.cpp
+ * @file src/components/ds18x20/controller.cpp
  *
  * Controller for the ds18x20.proto API
  *
diff --git a/src/components/ds18x20/controller.h b/src/components/ds18x20/controller.h
@@ -1,5 +1,5 @@
 /*!
- * @file controller.h
+ * @file src/components/ds18x20/controller.h
  *
  * Controller for the DS18X20 API
  *
diff --git a/src/components/ds18x20/hardware.cpp b/src/components/ds18x20/hardware.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file hardware.cpp
+ * @file src/components/ds18x20/hardware.cpp
  *
  * Hardware interface for the ds18x20.proto API
  *
diff --git a/src/components/ds18x20/hardware.h b/src/components/ds18x20/hardware.h
@@ -1,5 +1,5 @@
 /*!
- * @file model.h
+ * @file src/components/ds18x20/hardware.h
  *
  * Hardware implementation for the ds18x20.proto message.
  *
diff --git a/src/components/ds18x20/model.cpp b/src/components/ds18x20/model.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file model.cpp
+ * @file src/components/ds18x20/model.cpp
  *
  * Model for the ds18x20.proto message.
  *
diff --git a/src/components/ds18x20/model.h b/src/components/ds18x20/model.h
@@ -1,5 +1,5 @@
 /*!
- * @file model.h
+ * @file src/components/ds18x20/model.h
  *
  * Model interface for the DS18X20.proto message.
  *
diff --git a/src/components/i2c/controller.cpp b/src/components/i2c/controller.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file controller.cpp
+ * @file src/components/i2c/controller.cpp
  *
  * Controller for the i2c.proto API
  *
diff --git a/src/components/i2c/controller.h b/src/components/i2c/controller.h
@@ -1,5 +1,5 @@
 /*!
- * @file controller.h
+ * @file src/components/i2c/controller.h
  *
  * Routing controller for WipperSnapper's I2C component.
  *
diff --git a/src/components/i2c/hardware.cpp b/src/components/i2c/hardware.cpp
@@ -1,3 +1,17 @@
+/*!
+ * @file src/components/i2c/hardware.cpp
+ *
+ * Hardware implementation for the i2c.proto API
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Brent Rubell 2025 for Adafruit Industries.
+ *
+ * BSD license, all text here must be included in any redistribution.
+ *
+ */
 #include "hardware.h"
 
 /***********************************************************************/
diff --git a/src/components/i2c/hardware.h b/src/components/i2c/hardware.h
@@ -1,5 +1,5 @@
 /*!
- * @file hardware.cpp
+ * @file src/components/i2c/hardware.h
  *
  * Hardware driver for the i2c API
  *
diff --git a/src/components/i2c/model.cpp b/src/components/i2c/model.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file model.cpp
+ * @file src/components/i2c/model.cpp
  *
  * Model for the i2c.proto message.
  *
diff --git a/src/components/i2c/model.h b/src/components/i2c/model.h
@@ -1,5 +1,5 @@
 /*!
- * @file model.h
+ * @file src/components/i2c/model.h
  *
  * Provides high-level interfaces for messages within i2c.proto.
  *
diff --git a/src/components/pixels/controller.cpp b/src/components/pixels/controller.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file controller.cpp
+ * @file src/components/pixels/controller.cpp
  *
  * Implementation for the pixels API controller.
  *
diff --git a/src/components/pixels/controller.h b/src/components/pixels/controller.h
@@ -1,5 +1,5 @@
 /*!
- * @file controller.h
+ * @file src/components/pixels/controller.h
  *
  * Controller for the pixels API
  *
diff --git a/src/components/pixels/hardware.cpp b/src/components/pixels/hardware.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file hardware.cpp
+ * @file src/components/pixels/hardware.cpp
  *
  * Hardware interface for NeoPixel/DotStar strands.
  *
diff --git a/src/components/pixels/hardware.h b/src/components/pixels/hardware.h
@@ -1,5 +1,5 @@
 /*!
- * @file hardware.h
+ * @file src/components/pixels/hardware.h
  *
  * Hardware interface for NeoPixel/DotStar strands.
  *
diff --git a/src/components/pixels/model.cpp b/src/components/pixels/model.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file model.cpp
+ * @file src/components/pixels/model.cpp
  *
  * Implementation for the pixels.proto message model.
  *
diff --git a/src/components/pixels/model.h b/src/components/pixels/model.h
@@ -1,5 +1,5 @@
 /*!
- * @file model.h
+ * @file src/components/pixels/model.h
  *
  * Model for the pixels.proto message.
  *
diff --git a/src/components/sensor/model.cpp b/src/components/sensor/model.cpp
@@ -1,5 +1,5 @@
 /*!
- * @file model.cpp
+ * @file src/components/sensor/model.cpp
  *
  * Model for the sensor.proto message.
  *
diff --git a/src/components/sensor/model.h b/src/components/sensor/model.h
@@ -1,5 +1,5 @@
 /*!
- * @file model.h
+ * @file src/components/sensor/model.h
  *
  * Model for the sensor.proto message.
  *

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*!`
`2`		`- * @file controller.cpp`
	`2`	`+ * @file src/components/analogIO/controller.cpp`
`3`	`3`	`*`
`4`	`4`	`* Controller for the analogio.proto API`
`5`	`5`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*!`
`2`		`- * @file controller.h`
	`2`	`+ * @file src/components/analogIO/controller.h`
`3`	`3`	`*`
`4`	`4`	`* Controller for the AnalogIO API`
`5`	`5`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*!`
`2`		`- * @file hardware.cpp`
	`2`	`+ * @file src/components/analogIO/hardware.cpp`
`3`	`3`	`*`
`4`	`4`	`* Hardware interface for the analogio.proto API`
`5`	`5`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*!`
`2`		`- * @file model.h`
	`2`	`+ * @file src/components/analogIO/hardware.h`
`3`	`3`	`*`
`4`	`4`	`* Hardware implementation for the analogio.proto message.`
`5`	`5`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*!`
`2`		`- * @file model.cpp`
	`2`	`+ * @file src/components/analogIO/model.cpp`
`3`	`3`	`*`
`4`	`4`	`* Interfaces for the analogio.proto API`
`5`	`5`	`*`