Skip to content

Commit

Permalink
improving documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
TorstenRobitzki committed Apr 5, 2022
1 parent 5265372 commit f33a102
Show file tree
Hide file tree
Showing 5 changed files with 1,840 additions and 4 deletions.
4 changes: 2 additions & 2 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ PROJECT_BRIEF = "an alternative GATT/BLE implementation"
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.

PROJECT_LOGO =
PROJECT_LOGO = documentation/Logo_Bluetoe.svg

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
Expand Down Expand Up @@ -1191,7 +1191,7 @@ HTML_FOOTER =
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_STYLESHEET =
HTML_STYLESHEET = ./documentation/customdoxygen.css

# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
Expand Down
6 changes: 6 additions & 0 deletions bluetoe/bindings/nordic/nrf51/include/bluetoe/nrf51.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,11 @@ namespace bluetoe

namespace link_layer {

/** @cond HIDDEN_SYMBOLS */
/*
* specialize pdu_layout_by_radio<> for the radio that supports encryption to change the PDU layout
* to have that extra byte between header and body
*/
template < std::size_t TransmitSize, std::size_t ReceiveSize, typename CallBack, typename ... Options >
struct pdu_layout_by_radio<
nrf51_details::scheduled_radio< TransmitSize, ReceiveSize, CallBack, nrf51_details::scheduled_radio_base_with_encryption< Options... > > >
Expand All @@ -440,6 +445,7 @@ namespace bluetoe
*/
using pdu_layout = bluetoe::nrf_details::encrypted_pdu_layout;
};
/** @endcond */
}

} // namespace bluetoe
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ namespace l2cap {
{
public:
/**
* @copydoc signaling_channel::signaling_channel_input
* @copydoc signaling_channel::l2cap_input
*/
template < typename ConnectionData >
void l2cap_input( const std::uint8_t*, std::size_t, std::uint8_t*, std::size_t& out_size, ConnectionData& )
Expand All @@ -102,7 +102,7 @@ namespace l2cap {
}

/**
* @copydoc signaling_channel::signaling_channel_output
* @copydoc signaling_channel::l2cap_output
*/
template < typename ConnectionData >
void l2cap_output( std::uint8_t*, std::size_t& out_size, ConnectionData& )
Expand Down
2 changes: 2 additions & 0 deletions bluetoe/link_layer/include/bluetoe/link_layer.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -596,6 +596,7 @@ namespace link_layer {
};

// implementation
/** @cond HIDDEN_SYMBOLS */
template < class Server, template < std::size_t, std::size_t, class > class ScheduledRadio, typename ... Options >
link_layer< Server, ScheduledRadio, Options... >::link_layer()
: address_( local_device_address::address( *this ) )
Expand Down Expand Up @@ -1280,6 +1281,7 @@ namespace link_layer {

this->commit_l2cap_transmit_buffer( out_buffer );
}
/** @endcond */

}
}
Expand Down
Loading

0 comments on commit f33a102

Please sign in to comment.