Doxygen hade irrelevant methods

Author: pschatzmann

Doxyfile

@@ -2168,7 +2168,7 @@ PERLMOD_MAKEVAR_PREFIX =
 # C-preprocessor directives found in the sources and include files.
 # The default value is: YES.
 
-ENABLE_PREPROCESSING   = NO
+ENABLE_PREPROCESSING   = YES
 
 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
 # in the source code. If set to NO, only conditional compilation will be
@@ -2177,7 +2177,7 @@ ENABLE_PREPROCESSING   = NO
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-MACRO_EXPANSION        = NO
+MACRO_EXPANSION        = YES
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
 # the macro expansion is limited to the macros specified with the PREDEFINED and
@@ -2207,7 +2207,7 @@ INCLUDE_PATH           =
 # used.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-INCLUDE_FILE_PATTERNS  =
+INCLUDE_FILE_PATTERNS  = 
 
 # The PREDEFINED tag can be used to specify one or more macro names that are
 # defined before the preprocessor is started (similar to the -D option of e.g.
@@ -2217,8 +2217,8 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             =
-
+PREDEFINED  =  DOXYGEN IS_DESKTOP ESP32 ESP8266 ARDUINO_ARCH_MBED_RP2040 ARDUINO_ARCH_RP2040 __AVR__ STM32 ARDUINO_ARCH_SAMD
+ 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The
 # macro definition that is found in the sources will be used. Use the PREDEFINED

docs/ext/Print.h

@@ -32,6 +32,7 @@ namespace audio_tools {
 
 class Print {
 public:
+#ifndef DOXYGEN
     virtual size_t write(uint8_t ch){
 		// not implememnted: to be overritten
 		return 0;
@@ -41,20 +42,10 @@ class Print {
       return write((const uint8_t *)str, strlen(str));
     }
 
-    virtual size_t write(const uint8_t *buffer, size_t size){
-        if (buffer == nullptr) return 0;
-    	for (size_t j=0;j<size;j++){
-    		write(buffer[j]);
-    	}
-    	return size;
-    }
-
     virtual size_t write(const char *buffer, size_t size) {
       return write((const uint8_t *)buffer, size);
     }
 
-    virtual int availableForWrite() { return 1024; }
-
     virtual int print(const char* msg){
 		int result = strlen(msg);
 		return write(msg, result);
@@ -85,16 +76,32 @@ class Print {
 		return -1;
 	}
 
+#endif
+
+    virtual size_t write(const uint8_t *buffer, size_t size){
+        if (buffer == nullptr) return 0;
+    	for (size_t j=0;j<size;j++){
+    		write(buffer[j]);
+    	}
+    	return size;
+    }
+
+
+    virtual int availableForWrite() { return 1024; }
+
+
 	virtual void flush() { /* Empty implementation for backward compatibility */ }
 };
 
 class Stream : public Print {
 public:
 	virtual int available(){return 0;}
 	virtual size_t readBytes(uint8_t* buffer, size_t len) {return 0;}
+#ifndef DOXYGEN
 	virtual int read(){return -1;}
 	virtual int peek(){return -1;}
 	virtual void setTimeout(size_t t){}
+#endif
 	operator bool(){
 		return true;
 	}

docs/ext/Stream.h

@@ -56,14 +56,19 @@ class AudioStream : public Stream, public AudioBaseInfoDependent, public AudioBa
       p_notify = &bi;
   }
 
+#ifndef DOXYGEN
+
   virtual size_t readBytes(char *buffer, size_t length) {
     return readBytes((uint8_t *)buffer, length);
   }
 
+#endif
+
   virtual size_t readBytes(uint8_t *buffer, size_t length) STREAM_WRITE_OVERRIDE = 0;
 
   virtual size_t write(const uint8_t *buffer, size_t size) override = 0;
 
+
   operator bool() { return available() > 0; }
 
   virtual AudioBaseInfo audioInfo() override {
@@ -110,8 +115,9 @@ class AudioStreamX : public AudioStream {
   AudioStreamX& operator=(AudioStreamX const&) = delete;
 
   virtual size_t readBytes(uint8_t *buffer, size_t length) override { return not_supported(0); }
+#ifndef DOXYGEN
   virtual size_t write(const uint8_t *buffer, size_t size) override{ return not_supported(0); }
-  virtual size_t write(uint8_t) override { return not_supported(0); }
+#endif
   virtual int available() override { return not_supported(0); };
 
   virtual int read() override { return not_supported(-1); }