trema/pio
Packet parser and generator in Ruby – Read the documentation
This page shows an evaluation of the documentation of trema/pio.
Each class, module, method, etc. is given a grade based on how complete the docs are.
The bar above shows the distribution of these grades.
| Seems really good | ||
|---|---|---|
|
A
|
Pio::IPv4Address#mask! |
|
|
A
|
Pio::IPv4Address#mask |
|
|
A
|
Pio::Dhcp::FieldUtil |
|
|
A
|
Pio::Dhcp |
|
|
A
|
Pio |
|
| Show 72 more ... | ||
|
A
|
Pio::Dhcp::BootRequestOptions |
|
|
A
|
Pio::Dhcp::BootReplyOptions |
|
|
A
|
Pio::Icmp::Request::Options |
|
|
A
|
Pio::IPv4Address#prefixlen |
|
|
A
|
Pio::Arp::Request::Options |
|
|
A
|
Pio::Type::EthernetHeader |
|
|
A
|
Pio::Icmp::Reply::Options |
|
|
A
|
Pio::Dhcp::DhcpTlvOptions |
|
|
A
|
Pio::Dhcp::ParameterList |
|
|
A
|
Pio::Arp::Reply::Options |
|
|
A
|
Pio::MessageTypeSelector |
|
|
A
|
Pio::Dhcp::CommonOptions |
|
|
A
|
Pio::IPv4Address#to_ary |
|
|
A
|
Pio::Lldp::ChassisIdTlv |
|
|
A
|
Pio::Dhcp::OptionalTlv |
|
|
A
|
Pio::IPv4Address#value |
|
|
A
|
Pio::Lldp::OptionalTlv |
|
|
A
|
Pio::Features::Message |
|
|
A
|
Pio::Features::Request |
|
|
A
|
Pio::Type::MacAddress |
|
|
A
|
Pio::Type::IPv4Header |
|
|
A
|
Pio::IPv4Address#to_a |
|
|
A
|
Pio::Features::Reply |
|
|
A
|
Pio::Type::UdpHeader |
|
|
A
|
Pio::Lldp::PortIdTlv |
|
|
A
|
Pio::Type::IpAddress |
|
|
A
|
Pio::Dhcp::CsumUtil |
|
|
A
|
Pio::Mac#initialize |
|
|
A
|
Pio::Dhcp::ClientId |
|
|
A
|
Pio::Type::OpenFlow |
|
|
A
|
Pio::Echo::Message |
|
|
A
|
Pio::Dhcp::Message |
|
|
A
|
Pio::Echo::Request |
|
|
A
|
Pio::Icmp::Message |
|
|
A
|
Pio::Icmp::Options |
|
|
A
|
Pio::Lldp::Options |
|
|
A
|
Pio::Arp::Message |
|
|
A
|
Pio::Lldp::TtlTlv |
|
|
A
|
Pio::Icmp::Format |
|
|
A
|
Pio::Dhcp::Frame |
|
|
A
|
Pio::Lldp::Frame |
|
|
A
|
Pio::Echo::Reply |
|
|
A
|
Pio::Arp::Format |
|
|
A
|
Pio::Mac#inspect |
|
|
A
|
Pio::IPv4Address |
|
|
A
|
Pio::Mac#to_s |
|
|
A
|
Pio::Mac#to_i |
|
|
A
|
Pio::Mac#to_a |
|
|
A
|
Pio::Options |
|
|
A
|
Pio::Mac#== |
|
|
A
|
Pio::Hello |
|
|
A
|
Pio::Lldp |
|
|
A
|
Pio::Mac |
|
|
A
|
Pio::Hello.read |
|
|
A
|
Pio::Features::Request#initialize |
|
|
A
|
Pio::Hello#initialize |
|
|
A
|
Pio::Mac#to_str |
|
|
A
|
Pio::IPv4Address#class_d? |
|
|
A
|
Pio::Dhcp::BootRequest |
|
|
A
|
Pio::Dhcp::BootReply |
|
|
A
|
Pio::Dhcp::DhcpField |
|
|
A
|
Pio::Dhcp::Discover |
|
|
A
|
Pio::Icmp::Request |
|
|
A
|
Pio::Dhcp::Request |
|
|
A
|
Pio::Arp::Request |
|
|
A
|
Pio::Dhcp::Offer |
|
|
A
|
Pio::Icmp::Reply |
|
|
A
|
Pio::Arp::Reply |
|
|
A
|
Pio::Dhcp::Ack |
|
|
A
|
Pio::Features |
|
|
A
|
Pio::Echo |
|
|
A
|
Pio::Pcap |
|
| Proper documentation present | ||
|---|---|---|
|
B
|
Pio::Icmp::Reply::Options#initialize |
|
|
B
|
Pio::Type::IPv4Header#ipv4_header |
|
| Needs work | ||
|---|---|---|
|
C
|
Pio::IPv4Address#initialize |
|
| Undocumented | ||
|---|---|---|
|
U
|
Pio::Features::Reply#datapath_id |
|
|
U
|
Pio::Dhcp::DhcpTlvOptions#dhcp_server_identifier_hash |
|
|
U
|
Pio::Dhcp::DhcpTlvOptions#ip_address_lease_time_hash |
|
|
U
|
Pio::Dhcp::DhcpTlvOptions#rebinding_time_value_hash |
|
|
U
|
Pio::Dhcp::DhcpTlvOptions#requested_ip_address_hash |
|
| Show 115 more ... | ||
|
U
|
Pio::Dhcp::DhcpTlvOptions#renewal_time_value_hash |
|
|
U
|
Pio::Dhcp::DhcpTlvOptions#client_identifier_hash |
|
|
U
|
Pio::Dhcp::CommonOptions#ip_destination_address |
|
|
U
|
Pio::Dhcp::DhcpTlvOptions#parameters_list_hash |
|
|
U
|
Pio::Dhcp::CommonOptions#ip_address_lease_time |
|
|
U
|
Pio::Dhcp::CommonOptions#requested_ip_address |
|
|
U
|
Pio::Dhcp::CommonOptions#rebinding_time_value |
|
|
U
|
Pio::Dhcp::FieldUtil#relay_agent_ip_address |
|
|
U
|
Pio::Dhcp::DhcpTlvOptions#message_type_hash |
|
|
U
|
Pio::Dhcp::FieldUtil#next_server_ip_address |
|
|
U
|
Pio::Dhcp::CommonOptions#renewal_time_value |
|
|
U
|
Pio::Dhcp::CommonOptions#ip_source_address |
|
|
U
|
Pio::Dhcp::CommonOptions#server_identifier |
|
|
U
|
Pio::Dhcp::DhcpTlvOptions#subnet_mask_hash |
|
|
U
|
Pio::Lldp::Frame#organizationally_specific |
|
|
U
|
Pio::Dhcp::FieldUtil#ip_address_lease_time |
|
|
U
|
Pio::Dhcp::FieldUtil#rebinding_time_value |
|
|
U
|
Pio::Dhcp::FieldUtil#requested_ip_address |
|
|
U
|
Pio::Type::EthernetHeader#ethernet_header |
|
|
U
|
Pio::Dhcp::CommonOptions#destination_mac |
|
|
U
|
Pio::Dhcp::BootRequestOptions#initialize |
|
|
U
|
Pio::Dhcp::FieldUtil#client_mac_address |
|
|
U
|
Pio::Dhcp::FieldUtil#renewal_time_value |
|
|
U
|
Pio::Dhcp::CommonOptions#transaction_id |
|
|
U
|
Pio::Dhcp::FieldUtil#client_identifier |
|
|
U
|
Pio::Dhcp::BootReplyOptions#initialize |
|
|
U
|
Pio::Icmp::Request::Options#initialize |
|
|
U
|
Pio::Dhcp::FieldUtil#server_identifier |
|
|
U
|
Pio::Dhcp::FieldUtil#client_ip_address |
|
|
U
|
Pio::Arp::Request::Options#initialize |
|
|
U
|
Pio::Dhcp::BootRequestOptions#to_hash |
|
|
U
|
Pio::MessageTypeSelector#message_type |
|
|
U
|
Pio::Dhcp::CommonOptions#subnet_mask |
|
|
U
|
Pio::Dhcp::FieldUtil#parameters_list |
|
|
U
|
Pio::Lldp::Frame#system_capabilities |
|
|
U
|
Pio::Dhcp::FieldUtil#your_ip_address |
|
|
U
|
Pio::Type::OpenFlow#openflow_header |
|
|
U
|
Pio::Arp::Reply::Options#initialize |
|
|
U
|
Pio::Dhcp::BootReplyOptions#to_hash |
|
|
U
|
Pio::Dhcp::CommonOptions#source_mac |
|
|
U
|
Pio::Dhcp::FieldUtil#transaction_id |
|
|
U
|
Pio::Lldp::Frame#management_address |
|
|
U
|
Pio::Lldp::Frame#system_description |
|
|
U
|
Pio::Dhcp::CommonOptions#dhcp_data |
|
|
U
|
Pio::Icmp::Format#echo_data_length |
|
|
U
|
Pio::Features::Message.create_from |
|
|
U
|
Pio::Icmp::Format#ip_packet_length |
|
|
U
|
Pio::Arp::Request::Options#to_hash |
|
|
U
|
Pio::Dhcp::FieldUtil#hw_addr_type |
|
|
U
|
Pio::Dhcp::FieldUtil#message_type |
|
|
U
|
Pio::Features::Reply#capabilities |
|
|
U
|
Pio::Lldp::Frame#port_description |
|
|
U
|
Pio::Dhcp::Message#options_klass |
|
|
U
|
Pio::Dhcp::FieldUtil#hw_addr_len |
|
|
U
|
Pio::Arp::Reply::Options#to_hash |
|
|
U
|
Pio::Dhcp::FieldUtil#subnet_mask |
|
|
U
|
Pio::Dhcp::FieldUtil#bootp_flags |
|
|
U
|
Pio::Features::Reply#initialize |
|
|
U
|
Pio::Type::UdpHeader#udp_header |
|
|
U
|
Pio::Icmp::Message.create_from |
|
|
U
|
Pio::Lldp::OptionalTlv#chooser |
|
|
U
|
Pio::Dhcp::OptionalTlv#chooser |
|
|
U
|
Pio::Icmp::Format#message_type |
|
|
U
|
Pio::Dhcp::Message.create_from |
|
|
U
|
Pio::Features::Reply#n_buffers |
|
|
U
|
Pio::Echo::Message.create_from |
|
|
U
|
Pio::Echo::Message#initialize |
|
|
U
|
Pio::Dhcp::Message#const_type |
|
|
U
|
Pio::Arp::Format#message_type |
|
|
U
|
Pio::Lldp::Options#initialize |
|
|
U
|
Pio::Dhcp::Message#initialize |
|
|
U
|
Pio::Features::Reply#n_tables |
|
|
U
|
Pio::Arp::Message.create_from |
|
|
U
|
Pio::Dhcp::CommonOptions#type |
|
|
U
|
Pio::Options.mandatory_option |
|
|
U
|
Pio::Icmp::Message#initialize |
|
|
U
|
Pio::MessageTypeSelector#read |
|
|
U
|
Pio::Arp::Message#initialize |
|
|
U
|
Pio::Lldp::Frame#system_name |
|
|
U
|
Pio::Features::Reply#actions |
|
|
U
|
Pio::Dhcp::ParameterList#get |
|
|
U
|
Pio::Dhcp::ParameterList#set |
|
|
U
|
Pio::Dhcp::FieldUtil#seconds |
|
|
U
|
Pio::Lldp::ChassisIdTlv#get |
|
|
U
|
Pio::Icmp::Format#to_binary |
|
|
U
|
Pio::Lldp::ChassisIdTlv#set |
|
|
U
|
Pio::Lldp::Options#to_hash |
|
|
U
|
Pio::Features::Reply#ports |
|
|
U
|
Pio::Dhcp::Frame#to_binary |
|
|
U
|
Pio::Icmp::Options#to_hash |
|
|
U
|
Pio::Arp::Format#to_binary |
|
|
U
|
Pio::Icmp::Format#icmp_sum |
|
|
U
|
Pio::Type::MacAddress#set |
|
|
U
|
Pio::Type::MacAddress#get |
|
|
U
|
Pio::Dhcp::FieldUtil#hops |
|
|
U
|
Pio::Dhcp::Frame#udp_len |
|
|
U
|
Pio::Type::IpAddress#get |
|
|
U
|
Pio::Lldp::PortIdTlv#set |
|
|
U
|
Pio::Type::IpAddress#set |
|
|
U
|
Pio::Icmp::Format#ip_sum |
|
|
U
|
Pio::Dhcp::Frame#udp_sum |
|
|
U
|
Pio::Lldp::PortIdTlv#get |
|
|
U
|
Pio::Dhcp::Frame#ip_len |
|
|
U
|
Pio::Dhcp::ClientId#get |
|
|
U
|
Pio::Dhcp::ClientId#set |
|
|
U
|
Pio::Dhcp::Frame#ip_sum |
|
|
U
|
Pio::Lldp#port_number |
|
|
U
|
Pio::Lldp::TtlTlv#set |
|
|
U
|
Pio::Lldp::Frame#dpid |
|
|
U
|
Pio::Lldp::TtlTlv#get |
|
|
U
|
Pio::Lldp#initialize |
|
|
U
|
Pio::Lldp#to_binary |
|
|
U
|
Pio::Options.option |
|
|
U
|
Pio::Dhcp.read |
|
|
U
|
Pio::Lldp.read |
|
Let's raise the visibility of documentation in Ruby!
This page is for trema/pio and is part of a project called "Inch Pages", showing documentation measurements provided by Inch.
Inch Pages also provides a badge: 
(not counting low priority objects)
Can I have my own badges?
What is the goal of this?
I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.
Let's start a discussion, let's raise the visibility of documentation, let's talk.
Suggestions, feedback, critique: Hit me up on Twitter or via issue.
nch Pages