From 825f0c40e1eb5f24f3dd04bb585f2f92a86dec0f Mon Sep 17 00:00:00 2001 From: Naveen Albert Date: Thu, 2 Oct 2025 13:46:29 -0400 Subject: [PATCH] res_fax: Add XML documentation for channel variables. Document the channel variables currently set by SendFAX and ReceiveFAX. Resolves: #1505 --- res/res_fax.c | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/res/res_fax.c b/res/res_fax.c index af51bad9a9..94657b090b 100644 --- a/res/res_fax.c +++ b/res/res_fax.c @@ -120,8 +120,44 @@ This application is provided by res_fax, which is a FAX technology agnostic module that utilizes FAX technology resource modules to complete a FAX transmission. Session arguments can be set by the FAXOPT function and to check results of the ReceiveFAX() application. + + + Whether the fax transmission was successful + + + + + Description of what caused the fax to fail + + + + + Detailed description of the status of the fax transmission + + + Local Station ID + + + Remote Station ID + + + Number of pages in the fax + + + Bit rate of the fax transmission + + + Resolution of the fax document + + + Fax transmission mode + + + + + SendFAX FAXOPT @@ -162,8 +198,44 @@ This application is provided by res_fax, which is a FAX technology agnostic module that utilizes FAX technology resource modules to complete a FAX transmission. Session arguments can be set by the FAXOPT function and to check results of the SendFAX() application. + + + Whether the fax transmission was successful + + + + + Description of what caused the fax to fail + + + + + Detailed description of the status of the fax transmission + + + Local Station ID + + + Remote Station ID + + + Number of pages in the fax + + + Bit rate of the fax transmission + + + Resolution of the fax document + + + Fax transmission mode + + + + + ReceiveFAX FAXOPT