Skip to content
This repository was archived by the owner on Dec 18, 2018. It is now read-only.

Commit 2888781

Browse files
committed
docs(events): Add some comments so rustdoc is slightly more helpful
1 parent d1be673 commit 2888781

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,36 @@
1+
/// AWS Lambda event definitions for apigw.
12
pub mod apigw;
3+
/// AWS Lambda event definitions for appsync.
24
pub mod appsync;
5+
/// AWS Lambda event definitions for autoscaling.
36
pub mod autoscaling;
7+
/// AWS Lambda event definitions for cloudwatch_events.
48
pub mod cloudwatch_events;
9+
/// AWS Lambda event definitions for cloudwatch_logs.
510
pub mod cloudwatch_logs;
11+
/// AWS Lambda event definitions for code_commit.
612
pub mod code_commit;
13+
/// AWS Lambda event definitions for codepipeline_job.
714
pub mod codepipeline_job;
15+
/// AWS Lambda event definitions for cognito.
816
pub mod cognito;
17+
/// AWS Lambda event definitions for config.
918
pub mod config;
19+
/// AWS Lambda event definitions for connect.
1020
pub mod connect;
21+
/// AWS Lambda event definitions for firehose.
1122
pub mod firehose;
23+
/// AWS Lambda event definitions for iot_button.
1224
pub mod iot_button;
25+
/// AWS Lambda event definitions for kinesis.
1326
pub mod kinesis;
27+
/// AWS Lambda event definitions for lex.
1428
pub mod lex;
29+
/// AWS Lambda event definitions for s3.
1530
pub mod s3;
31+
/// AWS Lambda event definitions for ses.
1632
pub mod ses;
33+
/// AWS Lambda event definitions for sns.
1734
pub mod sns;
35+
/// AWS Lambda event definitions for sqs.
1836
pub mod sqs;

aws_lambda_events/src/lib.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ extern crate serde_json;
1414
extern crate serde_json;
1515

1616
mod custom_serde;
17+
/// Encodings used in AWS Lambda json event values.
1718
pub mod encodings;
19+
/// AWS Lambda event definitions.
1820
pub mod event;
1921
mod generated;

aws_lambda_events_codegen/src/main.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ fn write_mod_index(
7777
if overwrite_warning(&mod_path, overwrite).is_none() {
7878
let mut mod_content: Vec<String> = Vec::new();
7979
for parsed in parsed_files {
80+
mod_content.push(format!(
81+
"/// AWS Lambda event definitions for {}.",
82+
parsed.service_name
83+
));
8084
mod_content.push(format!(
8185
"pub mod {};",
8286
parsed

0 commit comments

Comments
 (0)